components:
responses: {}
schemas:
AgenticSystemCreateRequest:
additionalProperties: false
properties:
available_tools:
items:
oneOf:
- enum:
- web_search
- math
- image_gen
- code_interpreter
title: Builtin tools are tools the model is natively aware of and was
potentially fine-tuned with.
type: string
- additionalProperties: false
properties:
parameters:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
tool_name:
type: string
required:
- tool_name
- parameters
type: object
type: array
executable_tools:
items:
type: string
type: array
uniqueItems: true
instructions:
type: string
model:
enum:
- llama3_8b_chat
- llama3_70b_chat
type: string
required:
- instructions
- model
- available_tools
- executable_tools
type: object
AgenticSystemCreateResponse:
additionalProperties: false
properties:
agent_id:
type: string
required:
- agent_id
type: object
AgenticSystemExecuteRequest:
additionalProperties: false
properties:
agent_id:
type: string
messages:
items:
$ref: '#/components/schemas/Message'
type: array
stream:
default: false
type: boolean
turn_history:
items:
$ref: '#/components/schemas/AgenticSystemTurn'
type: array
required:
- agent_id
- messages
- turn_history
- stream
type: object
AgenticSystemExecuteResponse:
additionalProperties: false
properties:
turn:
$ref: '#/components/schemas/AgenticSystemTurn'
required:
- turn
title: non-stream response from the agentic system.
type: object
AgenticSystemExecuteResponseStreamChunk:
additionalProperties: false
properties:
stop_reason:
enum:
- not_stopped
- finished_ok
- max_tokens
title: Stop reasons are used to indicate why the model stopped generating
text.
type: string
turn:
$ref: '#/components/schemas/AgenticSystemTurn'
required:
- turn
title: Streamed agent execution response.
type: object
AgenticSystemTurn:
additionalProperties: false
properties:
response_message:
$ref: '#/components/schemas/Message'
steps:
items:
oneOf:
- additionalProperties: false
properties:
logprobs:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
step_type:
default: model_inference
enum:
- model_inference
- tool_execution
- safety_filtering
- memory_retrieval
title: The type of execution step.
type: string
text:
type: string
required:
- step_type
- text
type: object
- additionalProperties: false
properties:
step_type:
default: tool_execution
enum:
- model_inference
- tool_execution
- safety_filtering
- memory_retrieval
title: The type of execution step.
type: string
tool_calls:
items:
additionalProperties: false
properties:
arguments:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
tool_name:
type: string
required:
- tool_name
- arguments
title: A tool call is a request to a tool.
type: object
type: array
tool_responses:
items:
additionalProperties: false
properties:
response:
type: string
tool_name:
type: string
required:
- tool_name
- response
type: object
type: array
required:
- step_type
- tool_calls
- tool_responses
type: object
- additionalProperties: false
properties:
step_type:
default: safety_filtering
enum:
- model_inference
- tool_execution
- safety_filtering
- memory_retrieval
title: The type of execution step.
type: string
violation:
additionalProperties: false
properties:
details:
type: string
suggested_user_response:
type: string
violation_type:
type: string
required:
- violation_type
- details
type: object
required:
- step_type
type: object
- additionalProperties: false
properties:
documents:
items:
type: string
type: array
scores:
items:
type: number
type: array
step_type:
default: memory_retrieval
enum:
- model_inference
- tool_execution
- safety_filtering
- memory_retrieval
title: The type of execution step.
type: string
required:
- step_type
- documents
- scores
type: object
type: array
user_messages:
items:
$ref: '#/components/schemas/Message'
type: array
required:
- user_messages
- steps
- response_message
title: A single turn in an interaction with an Agentic System.
type: object
Attachment:
additionalProperties: false
properties:
mime_type:
type: string
url:
$ref: '#/components/schemas/URL'
required:
- url
- mime_type
title: Attachments are used to refer to external resources, such as images,
videos, audio, etc.
type: object
ChatCompletionRequest:
additionalProperties: false
properties:
available_tools:
items:
oneOf:
- enum:
- web_search
- math
- image_gen
- code_interpreter
title: Builtin tools are tools the model is natively aware of and was
potentially fine-tuned with.
type: string
- additionalProperties: false
properties:
parameters:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
tool_name:
type: string
required:
- tool_name
- parameters
type: object
type: array
logprobs:
default: false
type: boolean
max_tokens:
default: 0
type: integer
message:
$ref: '#/components/schemas/Message'
message_history:
items:
$ref: '#/components/schemas/Message'
type: array
model:
enum:
- llama3_8b_chat
- llama3_70b_chat
type: string
sampling_params:
additionalProperties: false
properties:
strategy:
default: greedy
type: string
temperature:
default: 0.0
type: number
top_k:
default: 0
type: integer
top_p:
default: 0.95
type: number
required:
- temperature
- strategy
- top_p
- top_k
type: object
stream:
default: false
type: boolean
required:
- message
- model
- message_history
- sampling_params
- available_tools
- max_tokens
- stream
- logprobs
type: object
ChatCompletionResponse:
additionalProperties: false
properties:
content:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
- items:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
type: array
logprobs:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
stop_reason:
enum:
- not_stopped
- finished_ok
- max_tokens
title: Stop reasons are used to indicate why the model stopped generating
text.
type: string
tool_calls:
items:
additionalProperties: false
properties:
arguments:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
tool_name:
type: string
required:
- tool_name
- arguments
title: A tool call is a request to a tool.
type: object
type: array
required:
- content
- tool_calls
title: Normal chat completion response.
type: object
ChatCompletionResponseStreamChunk:
additionalProperties: false
properties:
stop_reason:
enum:
- not_stopped
- finished_ok
- max_tokens
title: Stop reasons are used to indicate why the model stopped generating
text.
type: string
text_delta:
type: string
tool_call:
additionalProperties: false
properties:
arguments:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
tool_name:
type: string
required:
- tool_name
- arguments
title: A tool call is a request to a tool.
type: object
required:
- text_delta
title: Streamed chat completion response. The actual response is a series of
such objects.
type: object
CompletionRequest:
additionalProperties: false
properties:
content:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
- items:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
type: array
logprobs:
default: false
type: boolean
max_tokens:
default: 0
type: integer
model:
enum:
- llama3_8b
- llama3_70b
type: string
sampling_params:
additionalProperties: false
properties:
strategy:
default: greedy
type: string
temperature:
default: 0.0
type: number
top_k:
default: 0
type: integer
top_p:
default: 0.95
type: number
required:
- temperature
- strategy
- top_p
- top_k
type: object
stream:
default: false
type: boolean
required:
- content
- model
- sampling_params
- max_tokens
- stream
- logprobs
type: object
CompletionResponse:
additionalProperties: false
properties:
content:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
- items:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
type: array
logprobs:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
stop_reason:
enum:
- not_stopped
- finished_ok
- max_tokens
title: Stop reasons are used to indicate why the model stopped generating
text.
type: string
required:
- content
title: Normal completion response.
type: object
CompletionResponseStreamChunk:
additionalProperties: false
properties:
logprobs:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
stop_reason:
enum:
- not_stopped
- finished_ok
- max_tokens
title: Stop reasons are used to indicate why the model stopped generating
text.
type: string
text_delta:
type: string
required:
- text_delta
title: streamed completion response.
type: object
Message:
additionalProperties: false
properties:
content:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
- items:
oneOf:
- type: string
- $ref: '#/components/schemas/Attachment'
type: array
role:
enum:
- system
- user
- assistant
- tool
type: string
tool_calls:
items:
additionalProperties: false
properties:
arguments:
additionalProperties:
oneOf:
- type: 'null'
- type: boolean
- type: number
- type: string
- type: array
- type: object
type: object
tool_name:
type: string
required:
- tool_name
- arguments
title: A tool call is a request to a tool.
type: object
type: array
tool_responses:
items:
additionalProperties: false
properties:
response:
type: string
tool_name:
type: string
required:
- tool_name
- response
type: object
type: array
required:
- role
- content
- tool_calls
- tool_responses
type: object
URL:
format: uri
pattern: ^(https?://|file://|data:)
type: string
info:
description: This is the llama stack
title: Llama Stack specification
version: '0.1'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
openapi: 3.1.0
paths:
/agentic_system/create:
post:
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AgenticSystemCreateRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AgenticSystemCreateResponse'
description: OK
tags:
- AgenticSystem
/agentic_system/execute:
post:
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AgenticSystemExecuteRequest'
required: true
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AgenticSystemExecuteResponse'
- $ref: '#/components/schemas/AgenticSystemExecuteResponseStreamChunk'
description: non-stream response from the agentic system. **OR** Streamed
agent execution response.
tags:
- AgenticSystem
/chat_completion:
post:
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChatCompletionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ChatCompletionResponse'
- $ref: '#/components/schemas/ChatCompletionResponseStreamChunk'
description: Normal chat completion response. **OR** Streamed chat completion
response. The actual response is a series of such objects.
tags:
- Inference
/completion:
post:
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompletionRequest'
required: true
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/CompletionResponse'
- $ref: '#/components/schemas/CompletionResponseStreamChunk'
description: Normal completion response. **OR** streamed completion response.
tags:
- Inference
security:
- Default: []
servers:
- url: http://llama.meta.com
tags:
- name: Inference
- name: AgenticSystem
- description:
name: AgenticSystemCreateRequest
- description:
name: AgenticSystemCreateResponse
- description:
name: AgenticSystemExecuteRequest
- description: 'A single turn in an interaction with an Agentic System.
'
name: AgenticSystemTurn
- description: 'Attachments are used to refer to external resources, such as images,
videos, audio, etc.
'
name: Attachment
- description:
name: Message
- description:
name: URL
- description: 'non-stream response from the agentic system.
'
name: AgenticSystemExecuteResponse
- description: 'Streamed agent execution response.
'
name: AgenticSystemExecuteResponseStreamChunk
- description:
name: ChatCompletionRequest
- description: 'Normal chat completion response.
'
name: ChatCompletionResponse
- description: 'Streamed chat completion response. The actual response is a series
of such objects.
'
name: ChatCompletionResponseStreamChunk
- description:
name: CompletionRequest
- description: 'Normal completion response.
'
name: CompletionResponse
- description: 'streamed completion response.
'
name: CompletionResponseStreamChunk
x-tagGroups:
- name: Operations
tags:
- AgenticSystem
- Inference
- name: Types
tags:
- AgenticSystemCreateRequest
- AgenticSystemCreateResponse
- AgenticSystemExecuteRequest
- AgenticSystemExecuteResponse
- AgenticSystemExecuteResponseStreamChunk
- AgenticSystemTurn
- Attachment
- ChatCompletionRequest
- ChatCompletionResponse
- ChatCompletionResponseStreamChunk
- CompletionRequest
- CompletionResponse
- CompletionResponseStreamChunk
- Message
- URL