PAparallel-web
Responses API

Create Response

Changed on

Create a response.

Generates an answer to the given input, grounded in live web research and annotated with URL citations. Set model to parallel; reasoning.effort (low/medium/high/auto) controls how much research is performed, trading response time for answer quality. Returns an OpenAI-format Response as application/json, or a text/event-stream of OpenAI Responses SSE events when stream=true.

post/v1/responses

Request

  • Base URL
    https://api.parallel.ai
  • Auth
    API key in header x-api-key

Request body

modelstring required

The model to run. parallel is the only supported value (matched case-insensitively); any other value is rejected. To trade response time for answer quality, set reasoning.effort (low/medium/high/auto) rather than changing the model name.

instructionsstring nullable

System instructions for the model.

previous_response_idstring nullable

ID of a previous response to use as conversation context.

streamboolean nullable

Whether to stream the response.

metadataobject nullable

Arbitrary key-value pairs, echoed back on the Response object. Useful for tagging requests. At most 16 keys; keys up to 64 characters, values up to 512 characters.

backgroundboolean nullable

Background mode is not supported: requests with background=true are rejected with a 422 validation error. Use the Task API (POST /v1/tasks/runs) for long-running work.

Example request

{
  "model": "parallel",
  "reasoning": {
    "effort": "high"
  }
}

Response

Returns a Response object for non-streaming requests (application/json), or a stream of OpenAI Responses streaming events (text/event-stream) when stream=true is set in the request.

idstring required
created_atnumber required
instructionsstring nullable
metadataobject nullable
model'parallel'
object'response' required
parallel_tool_callsboolean required
temperaturenumber nullable
tool_choicestring
top_pnumber nullable
backgroundboolean nullable
completed_atnumber nullable
conversationunknown
max_output_tokensinteger nullable
max_tool_callsinteger nullable
previous_response_idstring nullable
promptunknown
prompt_cache_keystring nullable
prompt_cache_retention'in_memory' | '24h' nullable
safety_identifierstring nullable
service_tier'auto' | 'default' | 'flex' | 'scale' | 'priority' nullable
status'completed' | 'failed' | 'in_progress' | 'cancelled' | 'queued' | 'incomplete' nullable
top_logprobsinteger nullable
truncation'auto' | 'disabled' nullable
userstring nullable
effort_used'low' | 'medium' | 'high' nullable

The effort this response was served and billed at. For auto, the effort it picked for this query (either low or medium). Null until the response completes.

Changes

  • c4ae7c37e089Revision changes
    • warning

      added the new auto enum value to the ///// response property for the response status (media type: text/event-stream)

    • warning

      added the new auto enum value to the ///// response property for the response status (media type: text/event-stream)

    • warning

      added the new auto enum value to the ///// response property for the response status (media type: text/event-stream)

    • warning

      added the new auto enum value to the ///// response property for the response status (media type: text/event-stream)

    • warning

      added the new auto enum value to the ///// response property for the response status (media type: text/event-stream)

    • warning

      added the new auto enum value to the /// response property for the response status (media type: application/json)

    • info

      added the new auto enum value to the request property ///

    • info

      added the optional property // to the response with the status (media type: text/event-stream)

    • info

      added the optional property // to the response with the status (media type: text/event-stream)

    • info

      added the optional property // to the response with the status (media type: text/event-stream)

    • info

      added the optional property // to the response with the status (media type: text/event-stream)

    • info

      added the optional property // to the response with the status (media type: text/event-stream)

    • info

      added the optional property to the response with the status (media type: application/json)

  • fc4858951ccfRevision changes
    • info

      endpoint added