API Reference
Deployments
Fine-tuning
Multimedia
Admin
Build SDK (Deprecated)
{
"data": [
{
"created_at": 123,
"status": "<string>",
"model": "<string>",
"output": [
{
"id": "<string>",
"role": "<string>",
"content": [
{
"type": "<string>",
"text": "<string>"
}
],
"status": "<string>",
"type": "message"
}
],
"id": "<string>",
"object": "response",
"previous_response_id": "<string>",
"usage": {},
"error": {},
"incomplete_details": {},
"instructions": "<string>",
"max_output_tokens": 123,
"max_tool_calls": 2,
"parallel_tool_calls": true,
"reasoning": {},
"store": true,
"temperature": 1,
"text": {},
"tool_choice": "auto",
"tools": [
{}
],
"top_p": 1,
"truncation": "disabled",
"user": "<string>",
"metadata": {}
}
],
"has_more": true,
"object": "list",
"first_id": "<string>",
"last_id": "<string>"
}List Responses
Get a list of all responses for the authenticated account.
Args: limit: Maximum number of responses to return (default: 20, max: 100) after: Cursor for pagination - return responses after this ID before: Cursor for pagination - return responses before this ID
{
"data": [
{
"created_at": 123,
"status": "<string>",
"model": "<string>",
"output": [
{
"id": "<string>",
"role": "<string>",
"content": [
{
"type": "<string>",
"text": "<string>"
}
],
"status": "<string>",
"type": "message"
}
],
"id": "<string>",
"object": "response",
"previous_response_id": "<string>",
"usage": {},
"error": {},
"incomplete_details": {},
"instructions": "<string>",
"max_output_tokens": 123,
"max_tool_calls": 2,
"parallel_tool_calls": true,
"reasoning": {},
"store": true,
"temperature": 1,
"text": {},
"tool_choice": "auto",
"tools": [
{}
],
"top_p": 1,
"truncation": "disabled",
"user": "<string>",
"metadata": {}
}
],
"has_more": true,
"object": "list",
"first_id": "<string>",
"last_id": "<string>"
}Authorizations
Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>
Response
Successful Response
Response model for listing responses.
Returned from the GET /v1/responses endpoint. Provides a paginated list of response objects with cursor-based pagination support.
An array of response objects, sorted by creation time in descending order (most recent first).
Show child attributes
Show child attributes
The Unix timestamp (in seconds) when the response was created.
The status of the response. Can be 'completed', 'in_progress', 'incomplete', 'failed', or 'cancelled'.
The model used to generate the response (e.g., accounts/<ACCOUNT_ID>/models/<MODEL_ID>).
An array of output items produced by the model. Can contain messages, tool calls, and tool outputs.
Represents a message in a conversation.
- Message
- ToolCall
- ToolOutput
Show child attributes
Show child attributes
The unique identifier of the message.
The role of the message sender. Can be 'user', 'assistant', or 'system'.
An array of content parts that make up the message. Each part has a type and associated data.
The status of the message. Can be 'in_progress' or 'completed'.
The object type, always 'message'.
The unique identifier of the response. Will be None if store=False.
The object type, which is always 'response'.
The ID of the previous response in the conversation, if this response continues a conversation.
Token usage information for the request. Contains 'prompt_tokens', 'completion_tokens', and 'total_tokens'.
Error information if the response failed. Contains 'type', 'code', and 'message' fields.
Details about why the response is incomplete, if status is 'incomplete'. Contains 'reason' field which can be 'max_output_tokens', 'max_tool_calls', or 'content_filter'.
System instructions that guide the model's behavior. Similar to a system message.
The maximum number of tokens that can be generated in the response. Must be at least 1.
The maximum number of tool calls allowed in a single response. Must be at least 1.
x >= 1Whether to enable parallel function calling during tool use. Default is True.
Reasoning output from the model, if reasoning is enabled. Contains 'content' and 'type' fields.
Whether to store this response for future retrieval. If False, the response will not be persisted and previous_response_id cannot reference it. Default is True.
The sampling temperature to use, between 0 and 2. Higher values like 0.8 make output more random, while lower values like 0.2 make it more focused and deterministic. Default is 1.0.
0 <= x <= 2Text generation configuration parameters, if applicable.
Controls which (if any) tool the model should use. Can be 'none', 'auto', 'required', or an object specifying a particular tool. Default is 'auto'.
A list of tools the model may call. Each tool is defined with a type and function specification following the OpenAI tool format. Supports 'function', 'mcp', 'sse', and 'python' tool types.
An alternative to temperature sampling, called nucleus sampling, where the model considers the results of tokens with top_p probability mass. So 0.1 means only tokens comprising the top 10% probability mass are considered. Default is 1.0.
0 <= x <= 1The truncation strategy to use for the context. Can be 'auto' or 'disabled'. Default is 'disabled'.
A unique identifier representing your end-user, which can help Fireworks to monitor and detect abuse.
Set of up to 16 key-value pairs that can be attached to the response. Useful for storing additional information about the response in a structured format.
Indicates whether there are more responses available beyond this page. If true, use the 'last_id' value as the 'after' cursor to fetch the next page.
The object type, which is always 'list'.
The ID of the first response in the current page. Used for pagination.
The ID of the last response in the current page. Use this as the 'after' cursor to fetch the next page if has_more is true.
Was this page helpful?