主题
read-plane
Generated reference page for
spec/v1/api/read-plane.openapi.yaml.
Metadata
- Type: OpenAPI
- Source:
spec/v1/api/read-plane.openapi.yaml - Raw: View Raw
Summary
- Title: Agent Service Read Plane API
- Version: v1
- Paths: 14
- Operations: 27
- Servers: 1
Source
yaml
openapi: 3.1.0
info:
title: Agent Service Read Plane API
version: v1
description: >
Read Plane 负责 run 查询、消息、artifact、checkpoint、trace、日志和状态读取。
servers:
- url: https://api.agent-service.example.com
security:
- bearerAuth: []
paths:
/v1/runs:
get:
operationId: listRuns
summary: List runs
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- name: orgId
in: query
required: true
schema:
$ref: ../schemas/common/identity.json#/$defs/orgId
- name: status
in: query
schema:
$ref: ../schemas/common/enums.json#/$defs/taskStatus
- name: resourceType
in: query
schema:
$ref: ../schemas/common/enums.json#/$defs/taskResourceType
- name: resourceId
in: query
schema:
type: string
- name: contextId
in: query
schema:
type: string
responses:
'200':
description: Run page
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [total, offset, limit, list]
properties:
total:
type: integer
offset:
type: integer
limit:
type: integer
list:
type: array
items:
$ref: ../schemas/resources/run.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: getRun
summary: Get run detail
responses:
'200':
description: Run detail
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
$ref: ../schemas/resources/run.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/tree:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: getRunTree
summary: List run descendants
responses:
'200':
description: Run tree page
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [total, offset, limit, list]
properties:
total:
type: integer
offset:
type: integer
limit:
type: integer
list:
type: array
items:
$ref: ../schemas/resources/run.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/status:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: getRunStatus
summary: Get current run status
responses:
'200':
description: Current status
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [status]
properties:
status:
$ref: ../schemas/common/enums.json#/$defs/taskStatus
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/traces:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: listRunTraces
summary: List traces for a run
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- name: status
in: query
schema:
$ref: ../schemas/common/tracing.json#/$defs/traceStatus
- name: rootSpanName
in: query
schema:
type: string
responses:
'200':
description: Trace page
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [total, offset, limit, list]
properties:
total:
type: integer
offset:
type: integer
limit:
type: integer
list:
type: array
items:
$ref: ../schemas/resources/trace-summary.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/messages:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: listRunMessages
summary: List run messages
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- name: threadId
in: query
schema:
$ref: ../schemas/common/identity.json#/$defs/threadId
responses:
'200':
description: Message page
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [total, offset, limit, list]
properties:
total:
type: integer
offset:
type: integer
limit:
type: integer
list:
type: array
items:
$ref: ../schemas/resources/message-record.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/artifacts:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: listRunArtifacts
summary: List run artifacts
responses:
'200':
description: Artifact list
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: array
items:
$ref: ../schemas/resources/artifact.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/artifacts/{artifactId}:
parameters:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/artifactId'
get:
operationId: getRunArtifact
summary: Get run artifact
responses:
'200':
description: Artifact detail
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
$ref: ../schemas/resources/artifact.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/checkpoints:
parameters:
- $ref: '#/components/parameters/runId'
get:
operationId: listRunCheckpoints
summary: List run checkpoints
responses:
'200':
description: Checkpoint list
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: array
items:
$ref: ../schemas/resources/checkpoint.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/checkpoints/{checkpointId}:
parameters:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/checkpointId'
get:
operationId: getRunCheckpoint
summary: Get checkpoint detail
responses:
'200':
description: Checkpoint detail
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
$ref: ../schemas/resources/checkpoint.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/runs/{runId}/logs/{stream}:
parameters:
- $ref: '#/components/parameters/runId'
- $ref: '#/components/parameters/logStream'
get:
operationId: getRunLog
summary: Get run log
responses:
'200':
description: Plain text log body or streamed log
content:
text/plain:
schema:
type: string
default:
$ref: '#/components/responses/ErrorResponse'
/v1/traces/{traceId}:
parameters:
- $ref: '#/components/parameters/traceId'
get:
operationId: getTrace
summary: Get trace detail
responses:
'200':
description: Trace detail
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
$ref: ../schemas/resources/trace-summary.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/traces/{traceId}/spans:
parameters:
- $ref: '#/components/parameters/traceId'
get:
operationId: listTraceSpans
summary: List spans in a trace
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- name: status
in: query
schema:
$ref: ../schemas/common/tracing.json#/$defs/spanStatus
- name: spanType
in: query
schema:
$ref: ../schemas/common/tracing.json#/$defs/spanType
- name: parentSpanId
in: query
schema:
$ref: ../schemas/common/tracing.json#/$defs/spanId
responses:
'200':
description: Span page
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [total, offset, limit, list]
properties:
total:
type: integer
offset:
type: integer
limit:
type: integer
list:
type: array
items:
$ref: ../schemas/resources/agent-span.json
default:
$ref: '#/components/responses/ErrorResponse'
/v1/traces/{traceId}/events:
parameters:
- $ref: '#/components/parameters/traceId'
get:
operationId: listTraceEvents
summary: List events in a trace
parameters:
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- name: spanId
in: query
schema:
$ref: ../schemas/common/tracing.json#/$defs/spanId
- name: name
in: query
schema:
type: string
- name: includePayload
in: query
schema:
type: boolean
default: false
responses:
'200':
description: Trace event page
content:
application/json:
schema:
type: object
required: [code, message, data]
properties:
code:
type: integer
const: 0
message:
type: string
data:
type: object
required: [total, offset, limit, list]
properties:
total:
type: integer
offset:
type: integer
limit:
type: integer
list:
type: array
items:
$ref: ../schemas/resources/trace-event.json
default:
$ref: '#/components/responses/ErrorResponse'
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
parameters:
offset:
name: offset
in: query
schema:
type: integer
minimum: 0
default: 0
limit:
name: limit
in: query
schema:
type: integer
minimum: 1
maximum: 200
default: 20
runId:
name: runId
in: path
required: true
schema:
$ref: ../schemas/common/identity.json#/$defs/runId
traceId:
name: traceId
in: path
required: true
schema:
$ref: ../schemas/common/tracing.json#/$defs/traceId
artifactId:
name: artifactId
in: path
required: true
schema:
$ref: ../schemas/common/identity.json#/$defs/artifactId
checkpointId:
name: checkpointId
in: path
required: true
schema:
$ref: ../schemas/common/identity.json#/$defs/checkpointId
logStream:
name: stream
in: path
required: true
schema:
type: string
enum: [stdout, stderr]
responses:
ErrorResponse:
description: Error response
content:
application/json:
schema:
$ref: ../schemas/errors/error-envelope.json