Arize Phoenix chat API is one of 17 APIs that Arize Phoenix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 5 JSON Schema definitions.
Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 5 JSON Schemas.
This API exposes
2 operations
across 2 paths,
and defines 57 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://app.phoenix.arize.com.
The identity and technical contract details declared by the specification.
ToolApprovalResponded
object
Tool approval in responded state (user has approved or denied).
3 properties
2 required
AssistantMessageMetadata
object
Wire schema for the chat stream's messagemetadata payload.
3 properties
1 required
ToolInputAvailablePart
object
Tool part in input-available state.
8 properties
2 required
ToolOutputAvailablePart
object
Tool part in output-available state.
10 properties
2 required
DynamicToolInputAvailablePart
object
Dynamic tool part in input-available state.
9 properties
3 required
AssistantMessageMetadataUsageTokens
object
3 properties
3 required
ChatContext
Discriminated union of every UI-state context the agent understands.
ToolInputStreamingPart
object
Tool part in input-streaming state.
8 properties
2 required
TraceContext
object
3 properties
3 required
DatasetContext
object
Dataset the user is currently viewing or has bound to a workflow. Carries the dataset's relay node id and, when known, the active version node id. These IDs sc…
3 properties
2 required
PlaygroundInstanceContext
object
One mounted playground instance and its current model selection. experimentid carries the relay node id of the experiment produced by this instance's last data…
3 properties
1 required
ChatRequest
Discriminated union of chat request payloads.
SourceDocumentUIPart
object
A document source part of a message.
6 properties
3 required
ValidationError
object
5 properties
3 required
FileUIPart
object
A file part of a message.
5 properties
2 required
PlaygroundExperimentScaffoldContext
object
Experiment name/description/metadata the user has staged for the playground's next dataset-backed run, before that run has started. The playground UI lets the…
3 properties
AppContext
object
Per-turn browser clock context for resolving relative time requests.
3 properties
3 required
DynamicToolOutputErrorPart
object
Dynamic tool part in output-error state.
10 properties
4 required
ToolOutputDeniedPart
object
Tool part in output-denied state (tool was denied, terminal state).
8 properties
2 required
DynamicToolOutputAvailablePart
object
Dynamic tool part in output-available state.
11 properties
4 required
WebAccessContext
object
User's per-turn request to expose web search / fetch tools.
2 properties
2 required
ProjectContext
object
Project the user is currently viewing. spanfilter carries the project-scoped span filter expression when the span filter field is mounted — empty string when t…
4 properties
2 required
StepStartUIPart
object
A step boundary part of a message.
1 property
DynamicToolApprovalRequestedPart
object
Dynamic tool part in approval-requested state (awaiting user decision).
9 properties
3 required
BuiltInProviderModelSelection
object
Chat against a Phoenix built-in provider. Credentials and connection details (base URL, Azure endpoint, AWS region) are resolved from the secret store first an…
4 properties
3 required
ToolOutputErrorPart
object
Tool part in output-error state.
10 properties
3 required
GraphQLContext
object
GraphQL runtime state.
2 properties
2 required
TextUIPart
object
A text part of a message.
4 properties
1 required
SourceUrlUIPart
object
A source part of a message.
5 properties
2 required
ChatRegenerateMessage
object
Regenerate message extended with Phoenix-specific fields.
10 properties
4 required
DynamicToolApprovalRespondedPart
object
Dynamic tool part in approval-responded state (user approved/denied, execution pending).
9 properties
3 required
DynamicToolOutputDeniedPart
object
Dynamic tool part in output-denied state (tool was denied, terminal state).
9 properties
3 required
PlaygroundEvaluatorContext
object
One dataset evaluator on the mounted playground's roster. name is user-controlled; sanitize at every model-visible boundary.
5 properties
5 required
SubagentsContext
object
User's per-turn request to expose the subagent-spawning tool.
2 properties
2 required
ToolApprovalRequestedPart
object
Tool part in approval-requested state (awaiting user decision).
8 properties
2 required
AssistantMessageMetadataTraceIds
object
2 properties
2 required
PlaygroundBuiltinModelContext
object
Built-in playground model selection.
3 properties
2 required
LlmEvaluatorContext
object
LLM-evaluator create/edit form mounted in the current browser route.
2 properties
1 required
UIMessage
object
A message as displayed in the UI by Vercel AI Elements.
4 properties
3 required
DynamicToolInputStreamingPart
object
Dynamic tool part in input-streaming state.
9 properties
2 required
PlaygroundCustomProviderModelContext
object
Custom-provider playground model selection.
5 properties
4 required
ChatSubmitMessage
object
Submit message extended with Phoenix-specific fields.
9 properties
3 required
AgentSpanContext
object
Span the user has selected. Exactly one of spannodeid (relay) or otelspanid (OpenTelemetry hex) must be set. projectnodeid is optional because a span can be se…
4 properties
1 required
_SummarizeResponse
object
1 property
1 required
ToolApprovalRequested
object
Tool approval in requested state (awaiting user response).
1 property
1 required
PlaygroundContext
object
Playground prompt editor state mounted in the current browser route.
6 properties
1 required
_SummarizeRequest
object
Body for POST /agents/{agentid}/sessions/{sessionid}/summary. Carries the Vercel-style messages array; the backend owns the prompt and the structured-output to…
4 properties
2 required
HTTPValidationError
object
1 property
AssistantMetadataUIMessage
object
UIMessage with metadata narrowed to AssistantMessageMetadata.
4 properties
3 required
CodeEvaluatorContext
object
Code-evaluator create/edit form mounted in the current browser route.
2 properties
1 required
AssistantMessageMetadataUsage
object
2 properties
1 required
DataUIPart
object
Data part with dynamic type based on data name.
3 properties
2 required
ToolApprovalRespondedPart
object
Tool part in approval-responded state (user approved/denied, execution pending).
8 properties
2 required
CustomProviderModelSelection
object
Chat against a stored custom provider record.
3 properties
3 required
ReasoningUIPart
object
A reasoning part of a message.
4 properties
1 required
AssistantMessageMetadataUsageTokenDetails
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Arize Phoenix publishes across the network.
