Skip to main content
Fireworks AI logo
  • Category: artificial intelligence
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 9
  • Triggers: 0
  • Slug: FIREWORKS_AI
  • Version: 00000000_00

Tools

Slug: FIREWORKS_AI_CREATE_CHAT_COMPLETIONGenerate one non-streaming OpenAI-compatible chat completion from role-based messages using a caller-supplied Fireworks model or deployment ID.

Input Parameters

integer
Optional seed for best-effort repeatability.
string
One or more sequences that stop generation.
string
required
Exact Fireworks model or deployed-model identifier to invoke; discover candidates with the Fireworks AI model or deployment listing tools.
array
Function definitions the model may call.
number
Nucleus-sampling probability mass; normally tune this or temperature, not both.
array
required
Conversation messages in order; each item must contain a role and OpenAI-compatible content or tool-call data.
integer
Maximum number of tokens to generate; omit to use the model or provider default.
number
Sampling temperature; omit to use the provider default.
string
Whether and which supplied function tools the model may call.
object
Typed output format, such as JSON mode, JSON Schema, grammar, or text, when the model supports it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_CREATE_EMBEDDINGSCreate embedding vectors for one or more caller-provided inputs using a caller-supplied Fireworks embedding model.

Input Parameters

string
required
Text, a batch of up to 2048 texts, or arbitrary structured records whose keys are referenced by prompt_template. For example, input {‘text’: ‘Hello’, ‘source’: ‘docs’} can use prompt_template ‘Embed {text} from {source}’.
string
required
Exact embedding model identifier; Fireworks examples may use provider/model form rather than a full account resource name.
boolean
Whether to normalize returned vectors; omit to use the model default.
integer
Requested output vector dimensions when the selected model supports dimension reduction.
string
Template that substitutes structured-input keys, for example ‘Embed this text: {text}’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_GENERATE_MODEL_RESPONSEGenerate one non-streaming Responses API result, optionally continuing a stored response or using function, MCP, or SSE tools; storage is off by default.

Input Parameters

string
required
Text input or ordered input items. Use a plain string for simple prompts; to continue a function-tool loop, replay the model’s function_call item followed by a function_call_output item carrying the tool result.
string
required
Exact Fireworks model or deployed-model identifier to invoke; no model is selected by the toolkit.
boolean
Whether Fireworks should retain the response for later continuation; defaults to false for ephemeral calls.
array
Verified function, MCP, or SSE tool definitions available to the model.
number
Nucleus-sampling probability mass from 0 to 1; normally tune this or temperature, not both.
string ("auto" | "disabled")
Use ‘auto’ to truncate overlong context or ‘disabled’ to return an error; omit for the provider default.
number
Sampling temperature from 0 to 2; omit to use the provider default.
string
Whether the model must avoid tools, choose automatically, call at least one supplied tool, or call one specific named function tool.
string
System-level instructions that guide the model for this response.
integer
Maximum number of tool calls allowed for this response.
integer
Maximum number of output tokens across generated content; omit to use the model limit.
string
ID of a previously stored response to continue; omit for an independent response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_GET_DEPLOYMENTReturn configuration and serving status for one Fireworks deployment without scaling or modifying it.

Input Parameters

string
Comma-separated deployment fields to return; omit for the provider’s default projection.
string
required
Fireworks account ID containing the deployment.
string
required
Deployment resource ID within the account, obtainable with the Fireworks AI deployment listing tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_GET_MODELReturn metadata and status for one model resource in a Fireworks account; this does not test whether the model can serve inference.

Input Parameters

string
required
Model resource ID within the account, obtainable with the Fireworks AI model listing tool.
string
Comma-separated model fields to return; omit for the provider’s default projection.
string
required
Fireworks account ID containing the model resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_LIST_ACCOUNTSReturn one page of Fireworks accounts accessible to the API key so an agent can obtain account IDs for model and deployment discovery.

Input Parameters

string
Fireworks management API filter expression for accounts.
integer
Maximum accounts to return in this page (1-200).
string
Comma-separated account fields to return; omit for the provider’s default projection.
string
Continuation cursor returned by a previous call to this tool; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_LIST_DEPLOYMENTSReturn one page of deployment resources in a Fireworks account for deployment ID discovery and serving-capacity and status inspection.

Input Parameters

string
Fireworks management API filter expression for deployment resources.
string
Comma-separated deployment fields to order by; append ’ desc’ for descending order.
integer
Maximum deployment resources to return in this page (1-200).
string
Comma-separated deployment fields to return; omit for the provider’s default projection.
string
required
Fireworks account ID, obtainable with the Fireworks AI account listing tool.
string
Continuation cursor returned by a previous call to this tool; omit for the first page.
boolean
Whether to include soft-deleted deployment resources in discovery results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_LIST_MODELSReturn one page of model resources in a Fireworks account for model-ID discovery and status inspection; availability for inference is not guaranteed.

Input Parameters

string
Fireworks management API filter expression for model resources.
string
Comma-separated model fields to order by; append ’ desc’ for descending order.
integer
Maximum model resources to return in this page (1-200).
string
Comma-separated model fields to return; omit for the provider’s default projection.
string
required
Fireworks account ID, obtainable with the Fireworks AI account listing tool.
string
Continuation cursor returned by a previous call to this tool; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FIREWORKS_AI_RERANK_DOCUMENTSRank a provided document list by relevance to a query using an optional caller-supplied Fireworks reranker model.

Input Parameters

string
Optional task instruction supported by the selected reranker model.
string
Exact reranker model identifier; omit only when intentionally using Fireworks’ documented provider default.
string
required
Search query against which document relevance is scored.
integer
Maximum number of highest-ranked results to return.
array
required
Documents to score and reorder; result indices refer to this original array.
boolean
Whether each result should include its document text as well as its original index and relevance score.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not