Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

OpenResponses API

mistral.rs supports the OpenResponses API specification.

Endpoints

  • POST /v1/responses - Create a response
  • GET /v1/responses/{id} - Retrieve a response
  • DELETE /v1/responses/{id} - Delete a response
  • POST /v1/responses/{id}/cancel - Cancel a background response

Unsupported Parameters

The following parameters are accepted for API compatibility but will return errors if set to non-default values:

ParameterBehavior
parallel_tool_callsOnly true or omitted is supported; false returns an error
max_tool_callsNot supported; setting any value returns an error

mistral.rs Extensions

These additional parameters are available beyond the spec:

  • stop - Stop sequences
  • repetition_penalty - Token repetition penalty
  • top_k - Top-k sampling
  • grammar - Constrained generation grammar
  • min_p - Min-p sampling
  • dry_multiplier, dry_base, dry_allowed_length, dry_sequence_breakers - DRY sampling
  • web_search_options - Web search integration

See HTTP.md for usage examples.