OpenVibe.Actor API
Generated at from
openvibe-contracts v0.127.0 and
openvibe-sdk v0.37.0.
Server https://openvibe.actor. 7 routes performing 4 capabilities. OpenAPI 3.1 document.
GET /api/v1/agents
The agent systems Actor routes to, with what each can do, its trust class, its rate card and whether it is available now (GET /api/v1/agents, actor.agent-list-result@1), and which one a task would go
- Capabilities
- actor.agent.read
- Visibility
- public
- Response
application/jsonactor.agent-list-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>actor.agent.read</strong> (public): The agent systems Actor routes to, with what each can do, its trust class, its rate card and whether it is available now (GET /api/v1/agents, actor.agent-list-result@1), and which one a task would go to in a mode, with the reason for every candidate (POST /api/v1/route { task, mode }, a platform.placement-result@1; nothing runs). Public; no token needed.</p>POST /api/v1/route
The agent systems Actor routes to, with what each can do, its trust class, its rate card and whether it is available now (GET /api/v1/agents, actor.agent-list-result@1), and which one a task would go
- Capabilities
- actor.agent.read
- Visibility
- public
- Response
application/jsonactor.agent-list-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>actor.agent.read</strong> (public): The agent systems Actor routes to, with what each can do, its trust class, its rate card and whether it is available now (GET /api/v1/agents, actor.agent-list-result@1), and which one a task would go to in a mode, with the reason for every candidate (POST /api/v1/route { task, mode }, a platform.placement-result@1; nothing runs). Public; no token needed.</p>GET /api/v1/tasks
List your latest tasks, newest first (GET /api/v1/tasks?limit=&before=): each as platform.task@1, with a cursor for the next page.
- Capabilities
- actor.task.list
- Visibility
- public
- Response
application/jsonactor.task-list-result@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>actor.task.list</strong> (public): List your latest tasks, newest first (GET /api/v1/tasks?limit=&before=): each as platform.task@1, with a cursor for the next page.</p>POST /api/v1/tasks
Give OpenVibe.Actor a task: POST /api/v1/tasks with the task in plain words, a mode (cheapest, balanced, best, fastest, private) and a budget.
- Capabilities
- actor.task.create
- Visibility
- public
- Request body
application/jsonactor.task-create-request@1- Response
application/jsonplatform.task@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>actor.task.create</strong> (public): Give OpenVibe.Actor a task: POST /api/v1/tasks with the task in plain words, a mode (cheapest, balanced, best, fastest, private) and a budget. Actor picks the agent system for it with openvibe-sdk/placement, runs it, has a second model family check the result, and records the result, the cost to the cent and the explanation on the task (platform.task@1, answered 201 with state queued). POST /api/v1/tasks/:id/cancel stops a task that has not ended. A person's tasks are theirs; a token that names a project puts the task in that project. Each person has a daily free allowance; a task whose cheapest eligible agent would cost more than its budget fails with actor.budget.exceeded instead of running.</p>GET /api/v1/tasks/{id}
Read one of your tasks (platform.task@1: state, result, cost, explanation) with GET /api/v1/tasks/:id, and watch it live with GET /api/v1/tasks/:id/events: text/event-stream of actor.task-event@1 (sta
- Capabilities
- actor.task.read
- Visibility
- public
- Parameters
id(path, required)
- Response
application/jsonplatform.task@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>actor.task.read</strong> (public): Read one of your tasks (platform.task@1: state, result, cost, explanation) with GET /api/v1/tasks/:id, and watch it live with GET /api/v1/tasks/:id/events: text/event-stream of actor.task-event@1 (state changes, the agent's steps, the end), resumable with Last-Event-ID. Only the task's requester (or its project's tokens) can read it.</p>POST /api/v1/tasks/{id}/cancel
Give OpenVibe.Actor a task: POST /api/v1/tasks with the task in plain words, a mode (cheapest, balanced, best, fastest, private) and a budget.
- Capabilities
- actor.task.create
- Visibility
- public
- Parameters
id(path, required)
- Request body
application/jsonactor.task-create-request@1- Response
application/jsonplatform.task@1- Errors
- errors.problem@1 (application/problem+json)
Description
<p><strong>actor.task.create</strong> (public): Give OpenVibe.Actor a task: POST /api/v1/tasks with the task in plain words, a mode (cheapest, balanced, best, fastest, private) and a budget. Actor picks the agent system for it with openvibe-sdk/placement, runs it, has a second model family check the result, and records the result, the cost to the cent and the explanation on the task (platform.task@1, answered 201 with state queued). POST /api/v1/tasks/:id/cancel stops a task that has not ended. A person's tasks are theirs; a token that names a project puts the task in that project. Each person has a daily free allowance; a task whose cheapest eligible agent would cost more than its budget fails with actor.budget.exceeded instead of running.</p>GET /api/v1/tasks/{id}/events
Read one of your tasks (platform.task@1: state, result, cost, explanation) with GET /api/v1/tasks/:id, and watch it live with GET /api/v1/tasks/:id/events: text/event-stream of actor.task-event@1 (sta
- Capabilities
- actor.task.read
- Visibility
- public
- Parameters
id(path, required)
- Response
application/jsonplatform.task@1- Errors
- errors.problem@1 (application/problem+json)