> ## Documentation Index > Fetch the complete documentation index at: https://docs.agentsfleet.net/llms.txt > Use this file to discover all available pages before exploring further. # Read your fleet editor context > Returns current fleet setup, at most three creator-private conversations with at most 25 recent role rows each, and 25 filtered activity receipts. The complete response is limited to four mebibytes. Older whole turns or conversations move behind their continuation when that limit is reached. The conversation cursor binds creator, workspace and fleet. Older messages remain available through each draft's messages resource. Private responses must not be cached. ## OpenAPI ````yaml https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/fleets/{fleet_id}/authoring-context openapi: 3.1.0 info: title: agentsfleet API description: API for managing workspaces, fleets, triggers, and runs. contact: name: agentsfleet url: https://agentsfleet.net license: name: MIT identifier: MIT version: 1.0.0 servers: - url: https://api.agentsfleet.net description: Production security: [] paths: /v1/workspaces/{workspace_id}/fleets/{fleet_id}/authoring-context: get: tags: - Fleets summary: Read your fleet editor context description: >- Returns current fleet setup, at most three creator-private conversations with at most 25 recent role rows each, and 25 filtered activity receipts. The complete response is limited to four mebibytes. Older whole turns or conversations move behind their continuation when that limit is reached. The conversation cursor binds creator, workspace and fleet. Older messages remain available through each draft's messages resource. Private responses must not be cached. operationId: get_fleet_authoring_context parameters: - name: workspace_id in: path description: >- Workspace identifier (version 7 universally unique identifier, or UUID). required: true schema: type: string - name: fleet_id in: path description: Fleet identifier (version 7 universally unique identifier, or UUID). required: true schema: type: string - name: starting_after in: query description: >- Use next_cursor unchanged to read older conversations for this creator and fleet. required: false schema: type: string responses: '200': description: Bounded private editor context content: application/json: schema: $ref: '#/components/schemas/AuthoringContext' '400': description: Invalid query or cursor content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' '401': description: Unauthorized content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' '403': description: Forbidden content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' '404': description: Fleet or private draft unavailable content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' '429': description: Too many requests content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' '500': description: Internal failure content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' '503': description: Dependency unavailable content: application/problem+json: schema: $ref: '#/components/schemas/ProblemBody' security: - BearerAuth: [] components: schemas: AuthoringContext: type: object description: >- One read for current fleet setup, private conversations and filtered receipts. required: - fleet - conversations - activities properties: activities: $ref: '#/components/schemas/CursorPage_SetupActivity' description: >- Up to 25 recorded activity receipts; runtime bodies are excluded before paging. conversations: type: array items: $ref: '#/components/schemas/Conversation_Value_Value' description: >- Up to three of this creator's conversations, most recently updated first. fleet: $ref: '#/components/schemas/FleetResponse' description: Shared current setup, prerequisites and schedules. next_cursor: type: - string - 'null' description: More conversations for this creator, workspace and fleet, or null. ProblemBody: type: object description: The body every refusal carries, under `application/problem+json`. required: - docs_uri - title - detail - error_code - request_id properties: action_id: type: - string - 'null' description: 'On that 409 only: the action the gate held.' current_state: type: - string - 'null' description: 'On a 409 only: the state that forbade the transition.' detail: type: string description: One sentence on what was refused and why. docs_uri: type: string description: Where the error code is documented. error_code: type: string description: The registry code, stable across releases. etag: type: - string - 'null' description: >- On a 412 only: the resource's current entity tag, to refetch and retry. gate_id: type: - string - 'null' description: 'On an answered approval gate''s 409 only: the gate that was answered.' outcome: type: - string - 'null' description: 'On that 409 only: the answer that stands.' request_id: type: string description: The request this refusal answers, for support. resolved_at: type: - string - 'null' format: date-time description: 'On that 409 only: when the standing answer was given.' resolved_by: type: - string - 'null' description: 'On that 409 only: who gave it.' title: type: string description: A short name for the refusal, safe to show a person. user_message: type: - string - 'null' description: A curated sentence for end users, where the code has one. CursorPage_SetupActivity: type: object description: >- One page of results. `total` is null when unavailable; `next_cursor` is null on the last page. required: - items properties: items: type: array items: type: object description: >- Safe durable activity metadata, with no runtime request or response bodies. required: - event_id - event_type - status - request_json - created_at properties: created_at: type: string format: date-time description: When the receipt was written. event_id: type: string description: Stable event identity. event_type: type: string description: Always activity for this resource. request_json: type: string description: Safe receipt payload encoded as JSON text. status: type: string description: Recorded receipt status. description: Current bounded rows. next_cursor: type: - string - 'null' description: Use this value unchanged for the next page, or stop when null. total: type: - integer - 'null' format: int64 description: Known total, or null. minimum: 0 Conversation_Value_Value: type: object description: A current private draft and its recent durable message window. required: - draft - messages - truncated properties: draft: $ref: '#/components/schemas/Draft_Value_Value' description: Current creator-private setup and review. messages: type: array items: $ref: '#/components/schemas/Message' description: Up to 25 recent role rows, in sequence order. messages_starting_after: type: - string - 'null' description: >- Reuse with the draft messages endpoint and limit=25 to reconcile this window. truncated: type: boolean description: >- Older role rows can be read from the draft messages endpoint without a cursor. FleetResponse: type: object description: Shared fleet resource, returned by create, read and lifecycle changes. required: - id - name - status - etag - setup_etag - setup_revision - policy_semantics - definition - setup - start - schedules - webhook_urls - created_at - updated_at - events_processed - budget_used_nanos - pending_approvals - memory_access properties: budget_used_nanos: $ref: '#/components/schemas/Nanos' description: Exact lifetime spend in nanos. created_at: type: string format: date-time description: Creation timestamp, such as `2026-10-24T05:00:00.000Z`. definition: $ref: '#/components/schemas/FleetDefinition' description: Complete validated native setup, with no private transcript. etag: type: string description: Strong resource tag for name/status changes. events_processed: type: string description: Exact lifetime event count. id: type: string description: Fleet identity. memory_access: $ref: '#/components/schemas/MemoryAccess' description: Current independent shared-memory permissions. name: type: string description: Validated instance slug. pending_approvals: type: integer format: int64 description: Current unanswered approval gates. policy_semantics: type: string description: Pinned policy interpretation. schedules: type: array items: type: object description: Actual stored schedule observations. setup: type: object description: Live prerequisites and authorized recovery actions. setup_etag: type: string description: Strong setup tag for reviewed improvement application. setup_revision: type: string description: Exact decimal immutable setup revision. start: type: object description: Explicit initial-run progress. status: type: string description: Current lifecycle state. updated_at: type: string format: date-time description: Last update timestamp, such as `2026-10-24T05:00:00.000Z`. webhook_urls: type: array items: $ref: '#/components/schemas/WebhookUrl' description: Manual webhook addresses from the declared setup. Draft_Value_Value: type: object description: Creator-visible mutable draft and its latest immutable candidate. required: - id - state - title - etag - authoring_model_ref - cancelled_through properties: authoring_model_ref: type: string description: Explicit model for future messages. cancelled_through: type: string description: Highest cancelled message sequence, as a decimal string. candidate: oneOf: - $ref: '#/components/schemas/Candidate_Value' description: Latest accepted setup, absent before the first candidate. - type: 'null' closed_at: type: - string - 'null' format: date-time description: Closing timestamp, such as `2026-10-24T05:00:00.000Z`. etag: type: string description: Strong version for idle edits. expires_at: type: - string - 'null' format: date-time description: Private retention deadline, such as `2026-10-24T05:00:00.000Z`. id: type: string description: Private draft identity. linked_fleet_id: type: - string - 'null' description: Related fleet, when this draft targets or created one. publication: oneOf: - $ref: '#/components/schemas/Publication' description: Explicit publication receipt, never synthesized by Save. - type: 'null' review: type: - object - 'null' description: Complete effective setup, immutable requirements and live readiness. state: type: string description: editing, saving or closed. title: type: string description: Human display title. Message: type: object description: One user or assistant role in a durable request sequence. required: - save_requested - sequence - operation_id - role - state - created_at properties: candidate_id: type: - string - 'null' description: Accepted assistant proposal, when present. created_at: type: string format: date-time description: Acceptance timestamp, such as `2026-10-24T05:00:00.000Z`. failure: oneOf: - $ref: '#/components/schemas/Failure' description: Server-reported failure reason and suggested recovery action. - type: 'null' finished_at: type: - string - 'null' format: date-time description: Finish timestamp, such as `2026-10-24T05:00:00.000Z`. operation_id: type: string description: Accepted body replay key. role: type: string description: user or assistant. save_error_code: type: - string - 'null' description: >- A stable error code when the setup could not be saved. The conversation remains available. save_requested: type: boolean description: >- True when this accepted message requests saving after successful completion. sequence: type: string description: Decimal request sequence. state: type: string description: Durable queued/running/terminal state. text: type: - string - 'null' description: Text, when this role has private content. usage: oneOf: - $ref: '#/components/schemas/Usage' description: Provider usage and cumulative runtime charge, when recorded. - type: 'null' Nanos: type: string description: A whole number of nanos (10⁻⁹ US dollars) as a decimal string. pattern: ^(0|[1-9][0-9]*)$ FleetDefinition: type: object description: >- A complete native fleet setup: its description, instructions and configuration. required: - schema_version - description - instructions_md - config properties: config: $ref: '#/components/schemas/DefinitionConfig' description: The fleet's configuration. description: type: string description: >- Says what the fleet does, shown wherever it is listed. At most 32,768 characters. maxLength: 32768 minLength: 1 instructions_md: type: string description: The fleet's instructions, in Markdown, at most 32,768 characters. maxLength: 32768 schema_version: type: integer format: int32 description: The Definition format version. Only `1` is accepted. maximum: 1 minimum: 1 additionalProperties: false MemoryAccess: type: object description: Current shared-memory permissions. required: - read - publish properties: publish: type: boolean description: Publish permission. read: type: boolean description: Read permission. additionalProperties: false WebhookUrl: type: object description: Public manual-webhook address for one declared source. required: - source - url properties: source: type: string description: Declared provider. url: type: string description: Deployment-derived address. Candidate_Value: type: object description: >- Saved setup version and its server-assigned identifier. This version cannot change. required: - id - revision - definition - canonical_digest - policy_semantics properties: canonical_digest: type: string description: Canonical content identity. definition: $ref: '#/components/schemas/FleetDefinition' description: Complete validated native Definition. id: type: string description: Candidate identity. policy_semantics: type: string description: Pinned interpretation of the policy schema. revision: type: string description: Decimal draft-local revision. Publication: type: object description: The exact reusable snapshot explicitly published by this creator. required: - library_id - revision_id - canonical_digest properties: canonical_digest: type: string description: Content identity that Save can verify and reuse. library_id: type: string description: Reusable entry identity. revision_id: type: string description: Immutable published snapshot. Failure: type: object description: Safe durable failure; callers cannot supply diagnostics or action links. required: - reason - error_code - recovery_action properties: cause: type: - string - 'null' description: Model-stream failure category, without request or response content. error_code: type: string description: Stable central registry code. reason: $ref: '#/components/schemas/FailureReason' description: Server-reported failure reason. recovery_action: type: string description: Stable recovery action for the authorized client to render. Usage: type: object description: Creator-visible usage; unknown provider figures remain absent. required: - knowledge - runtime_cost_nanos properties: input_tokens: type: - integer - 'null' format: int64 description: Cumulative input, absent while unknown. minimum: 0 knowledge: $ref: '#/components/schemas/Knowledge' description: >- Context knowledge measured by the server, independent of runner estimates. output_tokens: type: - integer - 'null' format: int64 description: Cumulative output, absent while unknown. minimum: 0 provider_cost_nanos: type: - string - 'null' description: Physical provider cost, absent while unknown. runtime_cost_nanos: type: string description: Upward-rounded cumulative runtime cost. DefinitionConfig: type: object description: >- The `config` member of a Definition: the fleet's name and its runtime settings. required: - name - x-agentsfleet properties: name: type: string description: The fleet's name. maxLength: 64 minLength: 1 x-agentsfleet: $ref: '#/components/schemas/DefinitionRuntime' description: >- Every runtime setting: triggers, tools, credentials, network, budget and gates. additionalProperties: false FailureReason: type: string description: Allowed failure reasons, excluding user-supplied diagnostics and links. enum: - insufficient_balance - model_unavailable - context_too_large - provider_failed - provider_usage_unknown - attempt_timed_out - policy_changed Knowledge: type: string description: Whether all reported provider usage is known. enum: - known - unknown DefinitionRuntime: type: object description: The `x-agentsfleet` block, which holds every runtime setting. required: - tools - budget properties: budget: $ref: '#/components/schemas/DefinitionBudget' description: The most this fleet may spend. context: oneOf: - $ref: '#/components/schemas/DefinitionContext' description: Context-size settings for each run. - type: 'null' credentials: type: - array - 'null' items: type: string maxLength: 128 minLength: 1 description: The workspace secrets this fleet may read, by name. maxItems: 64 gates: oneOf: - $ref: '#/components/schemas/DefinitionGates' description: >- Which tool actions need a person's approval, and which repeated actions stop a run. - type: 'null' model: type: - string - 'null' description: The model this fleet runs on, passed to the runner unchanged. maxLength: 255 network: oneOf: - $ref: '#/components/schemas/DefinitionNetwork' description: The hosts this fleet may reach. - type: 'null' repositories: type: - array - 'null' items: type: string maxLength: 255 minLength: 1 description: >- The repositories this fleet's GitHub credentials may reach, as `owner/name`. Set together with `repository_access`. maxItems: 64 minItems: 1 repository_access: oneOf: - $ref: '#/components/schemas/DefinitionRepositoryAccess' description: >- How far those credentials reach. Set together with `repositories`. - type: 'null' repository_base: type: - string - 'null' description: >- The branch every pull request opens against. Required with `write`, refused with `read`. maxLength: 255 minLength: 1 tools: type: array items: type: string maxLength: 128 minLength: 1 description: >- The tools this fleet may call. An empty list means the fleet only answers. maxItems: 128 triggers: type: array items: $ref: '#/components/schemas/DefinitionTrigger' description: >- What may start a run of this fleet besides a message sent to it. Omit it, or leave it empty, for a fleet that is only ever talked to. maxItems: 8 additionalProperties: false DefinitionBudget: type: object description: Spending limits, each a decimal string of whole nanos. required: - daily_nanos properties: daily_nanos: type: string description: 'The daily limit: a decimal string of whole nanos, greater than zero.' maxLength: 19 minLength: 1 pattern: ^[0-9]+$ monthly_nanos: type: string description: >- The monthly limit, in the same form. Omit it to set no monthly limit. maxLength: 19 minLength: 1 pattern: ^[0-9]+$ additionalProperties: false DefinitionContext: type: object description: Context-size settings for each run. properties: context_cap_tokens: oneOf: - $ref: '#/components/schemas/DefinitionContextSetting' description: The most tokens a run's assembled context may hold. - type: 'null' memory_checkpoint_every: oneOf: - $ref: '#/components/schemas/DefinitionContextSetting' description: How often a run saves its memory. - type: 'null' stage_chunk_threshold: type: - number - 'null' format: double description: >- The fraction of the context, from 0 to 1, at which a stage splits into chunks. Zero means the runner chooses. maximum: 1 minimum: 0 tool_window: oneOf: - $ref: '#/components/schemas/DefinitionContextSetting' description: How much of the context tool output may fill. - type: 'null' additionalProperties: false DefinitionGates: type: object description: Approval and anomaly rules for a fleet's tool actions. properties: anomaly_rules: type: - array - 'null' items: $ref: '#/components/schemas/DefinitionAnomalyRule' description: The repeated-action patterns that stop a run. rules: type: - array - 'null' items: $ref: '#/components/schemas/DefinitionGateRule' description: The tool actions that need a person's approval. timeout_ms: type: - integer - 'null' format: int64 description: |- How long, in milliseconds, an approval may wait before it lapses. An out-of-range value is clamped to the nearest allowed one. additionalProperties: false DefinitionNetwork: type: object description: Where a fleet may reach on the network. properties: allow: type: - array - 'null' items: type: string maxLength: 255 minLength: 1 description: >- The hosts the fleet may reach. An empty list blocks every outbound request. maxItems: 64 read_only: type: - boolean - 'null' description: Whether outbound requests are limited to reads. read_post_paths: type: - array - 'null' items: type: string maxLength: 255 minLength: 1 description: >- The request paths that may still send `POST` when `read_only` is true. maxItems: 64 additionalProperties: false DefinitionRepositoryAccess: type: string description: How far a fleet's repository credentials reach. enum: - read - write DefinitionTrigger: oneOf: - type: object description: Starts on a signed delivery from an external provider. required: - source - type properties: credential_name: type: - string - 'null' description: >- A secret name to use instead of the provider's default, so two fleets on one provider can hold different secrets. maxLength: 128 minLength: 1 events: type: - array - 'null' items: type: string maxLength: 64 minLength: 1 description: The event names that start a run. Omit it to accept every event. maxItems: 16 minItems: 1 repositories: type: - array - 'null' items: type: string maxLength: 255 minLength: 1 description: >- The repositories whose deliveries may start a run, as `owner/name`. maxItems: 64 minItems: 1 source: type: string description: >- The provider that sends the delivery, as a lowercase slug: it is the last segment of the URL the fleet's deliveries are sent to. maxLength: 255 minLength: 1 type: type: string enum: - webhook verifier: oneOf: - $ref: '#/components/schemas/DefinitionWebhookVerifier' description: How the delivery proves it came from the provider. - type: 'null' - type: object description: Starts on a schedule. required: - schedule - type properties: message: type: - string - 'null' description: The message each scheduled run receives. maxLength: 255 schedule: type: string description: The schedule, as a cron expression. maxLength: 255 minLength: 1 timezone: type: - string - 'null' description: The time zone the schedule is read in. maxLength: 255 minLength: 1 type: type: string enum: - cron - type: object description: Starts when someone mentions the bot in one chat channel. required: - source - channels - type properties: channels: type: array items: type: string maxLength: 32 minLength: 9 description: The channel identifier, as a list with exactly one entry. maxItems: 1 minItems: 1 source: type: string description: The chat provider. maxLength: 255 minLength: 1 type: type: string enum: - mention description: One way a fleet can start a run. `type` selects the kind. DefinitionContextSetting: oneOf: - type: integer format: int32 description: An explicit value. minimum: 0 - $ref: '#/components/schemas/DefinitionContextAuto' description: The word `auto`. description: A number, or `auto` to let the runner choose. DefinitionAnomalyRule: type: object description: One repeated-action pattern that stops a run. required: - pattern - threshold_count - threshold_window_s properties: pattern: $ref: '#/components/schemas/DefinitionAnomalyPattern' description: The pattern to watch for. threshold_count: type: integer format: int32 description: How many repeats stop the run. maximum: 10000 minimum: 1 threshold_window_s: type: integer format: int32 description: The window, in seconds, the repeats are counted in. maximum: 86400 minimum: 1 additionalProperties: false DefinitionGateRule: type: object description: One rule for when a tool action needs a person. required: - tool - action properties: action: type: string description: The action on that tool. maxLength: 128 minLength: 1 behavior: $ref: '#/components/schemas/DefinitionGateBehavior' description: What happens when the rule applies. blast_radius: type: string description: How far an approval reaches, as shown to the person. maxLength: 255 condition: type: - string - 'null' description: A condition that narrows when the rule applies. maxLength: 255 gate_kind: type: string description: The kind of decision the person is asked to make. maxLength: 255 tool: type: string description: The tool the rule watches. maxLength: 128 minLength: 1 additionalProperties: false DefinitionWebhookVerifier: oneOf: - type: object description: Raw body with a prefixed hex digest. required: - header - scheme properties: header: type: string description: Header holding the signature. maxLength: 128 minLength: 1 pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$ scheme: type: string enum: - body-hex-sha256 additionalProperties: false - type: object description: Raw body with a bare hex digest. required: - header - scheme properties: header: type: string description: Header holding the signature. maxLength: 128 minLength: 1 pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$ scheme: type: string enum: - body-hex additionalProperties: false - type: object description: Raw body with a base64 digest. required: - header - scheme properties: header: type: string description: Header holding the signature. maxLength: 128 minLength: 1 pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$ scheme: type: string enum: - body-base64-sha256 additionalProperties: false - type: object description: Fixed Slack headers with a signed timestamp. required: - scheme properties: scheme: type: string enum: - slack-v0 additionalProperties: false - type: object description: Fixed Svix headers with a signed identifier and timestamp. required: - scheme properties: scheme: type: string enum: - svix-v1 additionalProperties: false description: >- The complete signing recipe. Fixed-header recipes accept no extra fields. DefinitionContextAuto: type: string description: The only word a context setting accepts. enum: - auto DefinitionAnomalyPattern: type: string description: A repeated-action pattern. enum: - same_action DefinitionGateBehavior: type: string description: What happens when an approval rule applies. enum: - approve - auto_kill securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Send a dashboard session token, an account API key (`agt_t`), or a command-line credential (`afc_`) as a Bearer token. Each endpoint lists accepted credential types. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.