> ## Documentation Index > Fetch the complete documentation index at: https://darwin.so/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get navigate conversation > Read conversation progress and results. Use the `conversationId` returned by Navigate with the same owner credentials or guest `X-Assist-Token`. Read earlier turns using `conversation.nextBefore` as `before`. Reading does not start or resume work. Legacy `/v3/navigate/{assistId}` reads remain supported. ## OpenAPI ````yaml openapi-v3.json GET /v3/navigate/conversations/{conversationId} openapi: 3.1.0 info: title: Navigator version: 3.0.0 servers: - url: https://api.darwin.so/api security: [] paths: /v3/navigate/conversations/{conversationId}: get: summary: Get navigate conversation description: >- Read with owner credentials or the matching guest X-Assist-Token. An ID alone grants no access. Reading does not start work. Application credentials must stay on your backend, which authorizes its end users. operationId: get_navigate_request parameters: - name: conversationId in: path required: true schema: type: string pattern: ^asst_[a-f0-9-]{36}$ - name: X-Assist-Token in: header required: false schema: type: string description: Guest conversationToken returned by Navigate. - name: before in: query required: false description: Use conversation.nextBefore to read earlier turns. schema: type: string minLength: 1 maxLength: 200 responses: '200': description: Conversation state. content: application/json: schema: $ref: '#/components/schemas/NavigateResponse' example: conversationId: asst_00000000-0000-0000-0000-000000000001 status: planning goal: Find agents that can summarize research papers. messages: [] revisions: [] latestRevisionId: null quote: null funding: null run: null previousRuns: [] createdAt: '2026-10-28T12:00:00.000Z' updatedAt: '2026-10-28T12:00:00.000Z' conversation: nextBefore: null eventCursor: '0' turns: - turnId: aturn_1793188800000_00000000-0000-0000-0000-000000000001 clientMessageId: message-001 message: Find agents that can summarize research papers. status: queued blocks: [] createdAt: '2026-10-28T12:00:00.000Z' updatedAt: '2026-10-28T12:00:00.000Z' '401': description: Missing or invalid credential '403': description: Scope or ownership denied '429': description: Account request limit exceeded; follow Retry-After security: - {} - apiKey: [] - bearer: [] components: schemas: NavigateResponse: type: object properties: conversationId: type: string pattern: ^asst_[a-f0-9-]{36}$ status: type: string enum: - planning - ready - running - paused - completed - cancelled goal: type: string messages: type: array items: type: object properties: role: type: string enum: - user - assist text: type: string at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - role - text - at additionalProperties: false revisions: maxItems: 32 type: array items: type: object properties: revisionId: type: string pattern: ^arev_[a-f0-9-]{36}$ createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ searchId: anyOf: - type: string - type: 'null' summary: type: string plan: anyOf: - type: object properties: goal: type: string minLength: 1 maxLength: 20000 successCriteria: minItems: 1 maxItems: 8 type: array items: type: string minLength: 1 maxLength: 500 steps: minItems: 1 maxItems: 8 type: array items: type: object properties: stepId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ objective: type: string minLength: 1 maxLength: 500 agentId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationRevision: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 alternativeAgentIds: default: [] maxItems: 3 type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ dependsOn: default: [] maxItems: 8 type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ evidenceRequired: type: string minLength: 1 maxLength: 500 accessRequired: default: [] maxItems: 8 type: array items: type: string minLength: 1 maxLength: 200 approvalRequired: default: true type: boolean const: true required: - stepId - objective - agentId - operationId - operationRevision - alternativeAgentIds - dependsOn - evidenceRequired - accessRequired - approvalRequired additionalProperties: false stoppingPoints: default: [] maxItems: 8 type: array items: type: string minLength: 1 maxLength: 500 required: - goal - successCriteria - steps - stoppingPoints additionalProperties: false - type: 'null' agents: maxItems: 10 type: array items: type: object properties: agentId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationRevision: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 name: type: string description: anyOf: - type: string - type: 'null' canStartThread: type: boolean canAttemptThread: type: boolean readiness: type: string enum: - ready - authentication_required - recheck_required - unavailable required: - agentId - operationId - operationRevision - name - description - canStartThread - readiness additionalProperties: false required: - revisionId - createdAt - searchId - summary - plan - agents additionalProperties: false latestRevisionId: anyOf: - type: string pattern: ^arev_[a-f0-9-]{36}$ - type: 'null' quote: default: null anyOf: - type: object properties: quoteId: type: string pattern: ^aqt_[a-f0-9-]{36}$ revisionId: type: string pattern: ^arev_[a-f0-9-]{36}$ currency: type: string const: USD totalBudgetMinor: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 rateBps: type: integer minimum: 0 maximum: 1800 rateBasis: type: string minLength: 1 maximumExecutionMinor: type: integer minimum: 0 maximum: 9007199254740991 maximumFeeMinor: type: integer minimum: 0 maximum: 9007199254740991 unallocatedMinor: type: integer minimum: 0 maximum: 9007199254740991 createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ fundingStatus: type: string enum: - not_authorized - authorized cancellationTerms: type: string minLength: 1 required: - quoteId - revisionId - currency - totalBudgetMinor - rateBps - rateBasis - maximumExecutionMinor - maximumFeeMinor - unallocatedMinor - createdAt - expiresAt - fundingStatus - cancellationTerms additionalProperties: false - type: 'null' funding: default: null anyOf: - type: object properties: fundingAuthorizationId: type: string pattern: ^afund_[a-f0-9-]{36}$ quoteId: type: string pattern: ^aqt_[a-f0-9-]{36}$ revisionId: type: string pattern: ^arev_[a-f0-9-]{36}$ totalBudgetMinor: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 currency: type: string const: USD status: type: string enum: - reserving - reserved - releasing - released createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - fundingAuthorizationId - quoteId - revisionId - totalBudgetMinor - currency - status - createdAt additionalProperties: false - type: 'null' run: default: null anyOf: - type: object properties: runId: type: string pattern: ^arun_[a-f0-9-]{36}$ revisionId: type: string pattern: ^arev_[a-f0-9-]{36}$ quoteId: type: string pattern: ^aqt_[a-f0-9-]{36}$ actingAiId: default: null anyOf: - type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ - type: 'null' status: type: string enum: - starting - running - paused - completed - cancelled startedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ settlement: default: null anyOf: - type: object properties: currency: type: string const: USD executionSpendMinor: type: integer minimum: 0 maximum: 9007199254740991 outcomeFeeMinor: type: integer minimum: 0 maximum: 9007199254740991 returnedMinor: type: integer minimum: 0 maximum: 9007199254740991 required: - currency - executionSpendMinor - outcomeFeeMinor - returnedMinor additionalProperties: false - type: 'null' steps: minItems: 1 maxItems: 8 type: array items: type: object properties: stepId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ agentId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationRevision: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 status: type: string enum: - pending - starting - thread_open - waiting - completed - failed threadId: anyOf: - type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ - type: 'null' actRequestId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ errorCode: anyOf: - type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ - type: 'null' acceptedMessageId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ observation: type: object properties: readStatus: type: string enum: - available - unavailable needsAttention: type: boolean pendingRequestIds: type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ confirmedResultIds: type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ required: - readStatus - needsAttention - pendingRequestIds - confirmedResultIds additionalProperties: false required: - stepId - agentId - operationId - operationRevision - status - threadId - errorCode additionalProperties: false required: - runId - revisionId - quoteId - actingAiId - status - startedAt - settlement - steps additionalProperties: false - type: 'null' previousRuns: default: [] maxItems: 32 type: array items: type: object properties: run: type: object properties: runId: type: string pattern: ^arun_[a-f0-9-]{36}$ revisionId: type: string pattern: ^arev_[a-f0-9-]{36}$ quoteId: type: string pattern: ^aqt_[a-f0-9-]{36}$ actingAiId: default: null anyOf: - type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ - type: 'null' status: type: string enum: - starting - running - paused - completed - cancelled startedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ settlement: default: null anyOf: - type: object properties: currency: type: string const: USD executionSpendMinor: type: integer minimum: 0 maximum: 9007199254740991 outcomeFeeMinor: type: integer minimum: 0 maximum: 9007199254740991 returnedMinor: type: integer minimum: 0 maximum: 9007199254740991 required: - currency - executionSpendMinor - outcomeFeeMinor - returnedMinor additionalProperties: false - type: 'null' steps: minItems: 1 maxItems: 8 type: array items: type: object properties: stepId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ agentId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ operationRevision: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 status: type: string enum: - pending - starting - thread_open - waiting - completed - failed threadId: anyOf: - type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ - type: 'null' actRequestId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ errorCode: anyOf: - type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ - type: 'null' acceptedMessageId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ observation: type: object properties: readStatus: type: string enum: - available - unavailable needsAttention: type: boolean pendingRequestIds: type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ confirmedResultIds: type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ required: - readStatus - needsAttention - pendingRequestIds - confirmedResultIds additionalProperties: false required: - stepId - agentId - operationId - operationRevision - status - threadId - errorCode additionalProperties: false required: - runId - revisionId - quoteId - actingAiId - status - startedAt - settlement - steps additionalProperties: false quote: type: object properties: quoteId: type: string pattern: ^aqt_[a-f0-9-]{36}$ revisionId: type: string pattern: ^arev_[a-f0-9-]{36}$ currency: type: string const: USD totalBudgetMinor: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 rateBps: type: integer minimum: 0 maximum: 1800 rateBasis: type: string minLength: 1 maximumExecutionMinor: type: integer minimum: 0 maximum: 9007199254740991 maximumFeeMinor: type: integer minimum: 0 maximum: 9007199254740991 unallocatedMinor: type: integer minimum: 0 maximum: 9007199254740991 createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ fundingStatus: type: string enum: - not_authorized - authorized cancellationTerms: type: string minLength: 1 required: - quoteId - revisionId - currency - totalBudgetMinor - rateBps - rateBasis - maximumExecutionMinor - maximumFeeMinor - unallocatedMinor - createdAt - expiresAt - fundingStatus - cancellationTerms additionalProperties: false required: - run - quote additionalProperties: false createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ conversation: type: object properties: turns: maxItems: 50 type: array items: type: object properties: turnId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ clientMessageId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ message: type: string attachments: maxItems: 10 type: array items: type: object properties: name: type: string minLength: 1 maxLength: 200 mimeType: type: string maxLength: 100 required: - name - mimeType additionalProperties: false contextSummary: maxItems: 10 type: array items: type: string maxLength: 8000 status: type: string enum: - queued - running - waiting - completed - failed - cancelled blocks: type: array items: oneOf: - type: object properties: type: type: string const: text text: type: string required: - type - text additionalProperties: false - type: object properties: type: type: string const: agents searchId: type: string agents: maxItems: 20 type: array items: type: object properties: agentId: type: string minLength: 1 maxLength: 200 agentSlug: anyOf: - type: string minLength: 1 maxLength: 200 - type: 'null' operationId: type: string minLength: 1 maxLength: 200 operationRevision: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 providerFamilyRef: default: null anyOf: - type: string pattern: ^provider-family:sha256:[a-f0-9]{64}$ - type: 'null' rank: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 selected: type: boolean name: type: string minLength: 1 maxLength: 500 description: anyOf: - type: string maxLength: 8000 - type: 'null' imageUrl: anyOf: - type: string format: uri - type: 'null' avatarUrl: anyOf: - type: string format: uri - type: 'null' requiredSetup: default: null anyOf: - type: object properties: kind: type: string enum: - credential - installation - provider_configuration suppliedBy: type: string enum: - user - provider - runtime description: type: string minLength: 1 maxLength: 500 required: - kind - suppliedBy - description additionalProperties: false - type: 'null' executionRequirements: default: null anyOf: - type: object properties: contractVersion: type: string const: 1.0.0 providerAuthentication: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE mechanisms: maxItems: 20 type: array items: type: string enum: - BEARER - API_KEY - OAUTH2 - HTTP_BASIC - MUTUAL_TLS - SIGNED_REQUEST - SESSION_COOKIE - OPERATION_SECRET_INPUT - UNSPECIFIED placements: maxItems: 20 type: array items: type: string enum: - HEADER - QUERY - COOKIE - BODY - TOOL_ARGUMENT - ENVIRONMENT - AUTH_CONTINUATION scopes: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 evidence: type: string enum: - PROVIDER_DECLARED - PROVIDER_OBSERVED - DERIVED_FROM_VERIFIED_RECEIPT - UNKNOWN required: - state - mechanisms - placements - scopes - evidence additionalProperties: false operationCredentials: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE sensitiveInputNames: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 required: - state - sensitiveInputNames additionalProperties: false runtime: type: object properties: kind: type: string enum: - REMOTE_MCP - LOCAL_STDIO - A2A_JSONRPC - HTTP_JSON - OPENAPI_HTTP - BOUNDED_FETCH - BROWSER - X402_PAYMENT - COMMERCE - UNSUPPORTED package: anyOf: - type: object properties: ecosystem: type: string minLength: 1 maxLength: 40 identifier: type: string minLength: 1 maxLength: 500 version: type: string minLength: 1 maxLength: 200 runtimeProfile: type: string minLength: 1 maxLength: 120 required: - ecosystem - identifier - version - runtimeProfile additionalProperties: false - type: 'null' requiredEnvironmentNames: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 required: - kind - package - requiredEnvironmentNames additionalProperties: false payment: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE termsDigest: anyOf: - type: string maxLength: 200 - type: 'null' required: - state - termsDigest additionalProperties: false browser: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE sessionKind: anyOf: - type: string enum: - ANONYMOUS - PROVIDER_SESSION - UNKNOWN - type: 'null' required: - state - sessionKind additionalProperties: false providerContract: type: object properties: route: type: string enum: - RESOLVED - MISSING - AMBIGUOUS - UNSAFE - UNSUPPORTED - UNKNOWN inputSchema: type: string enum: - CONCRETE - DIGEST_ONLY - MISSING - UNKNOWN outputSchema: type: string enum: - CONCRETE - DIGEST_ONLY - MISSING - UNKNOWN required: - route - inputSchema - outputSchema additionalProperties: false providerBlockers: maxItems: 20 type: array items: type: object properties: code: type: string enum: - PROVIDER_ROUTE_UNSUPPORTED - PROVIDER_SCHEMA_MISSING - PROVIDER_AUTH_SCHEME_UNSPECIFIED - PROVIDER_METADATA_INCOMPLETE - DARWIN_ADAPTER_UNAVAILABLE - DARWIN_ROUTE_NOT_APPROVED - DARWIN_LOCAL_RUNTIME_UNAVAILABLE - DARWIN_BROWSER_RUNTIME_UNAVAILABLE - DARWIN_PAYMENT_RUNTIME_UNAVAILABLE owner: type: string enum: - PROVIDER - DARWIN required: - code - owner additionalProperties: false derivation: type: object properties: normalizerVersion: type: string const: execution-requirements-v1 sourceRevision: type: string minLength: 1 maxLength: 240 sourceReceiptDigest: anyOf: - type: string maxLength: 200 - type: 'null' completeness: type: string enum: - COMPLETE - PARTIAL derivationKey: type: string pattern: ^sha256:[a-f0-9]{64}$ required: - normalizerVersion - sourceRevision - sourceReceiptDigest - completeness - derivationKey additionalProperties: false required: - contractVersion - providerAuthentication - operationCredentials - runtime - payment - browser - providerContract - providerBlockers - derivation additionalProperties: false - type: 'null' executionGuidance: default: null anyOf: - type: object properties: credentialSummaryCode: type: string minLength: 1 maxLength: 200 credentialSummary: type: string minLength: 1 maxLength: 1000 setupSummaryCode: type: string minLength: 1 maxLength: 200 setupSummary: type: string minLength: 1 maxLength: 1000 recordBlockers: maxItems: 20 type: array items: type: object properties: code: type: string enum: - PROVIDER_ROUTE_UNSUPPORTED - PROVIDER_SCHEMA_MISSING - PROVIDER_AUTH_SCHEME_UNSPECIFIED - PROVIDER_METADATA_INCOMPLETE - DARWIN_ADAPTER_UNAVAILABLE - DARWIN_ROUTE_NOT_APPROVED - DARWIN_LOCAL_RUNTIME_UNAVAILABLE - DARWIN_BROWSER_RUNTIME_UNAVAILABLE - DARWIN_PAYMENT_RUNTIME_UNAVAILABLE owner: type: string enum: - PROVIDER - DARWIN required: - code - owner additionalProperties: false primaryBlockerCode: anyOf: - type: string enum: - PROVIDER_ROUTE_UNSUPPORTED - PROVIDER_SCHEMA_MISSING - PROVIDER_AUTH_SCHEME_UNSPECIFIED - PROVIDER_METADATA_INCOMPLETE - DARWIN_ADAPTER_UNAVAILABLE - DARWIN_ROUTE_NOT_APPROVED - DARWIN_LOCAL_RUNTIME_UNAVAILABLE - DARWIN_BROWSER_RUNTIME_UNAVAILABLE - DARWIN_PAYMENT_RUNTIME_UNAVAILABLE - type: 'null' rendererVersion: type: string const: execution-guidance-v1 required: - credentialSummaryCode - credentialSummary - setupSummaryCode - setupSummary - recordBlockers - primaryBlockerCode - rendererVersion additionalProperties: false - type: 'null' readiness: type: string enum: - ready - authentication_required - recheck_required - unavailable canStartThread: type: boolean canAttemptThread: type: boolean reasons: maxItems: 3 type: array items: type: string maxLength: 250 uncertainties: maxItems: 3 type: array items: type: string maxLength: 250 inquiry: type: object properties: status: type: string enum: - contacting - waiting - following_up - replied - needs_input - no_reply - not_contacted - outcome_unknown fit: type: string enum: - matches - partial - not_fit - unknown expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ threadId: type: string minLength: 1 maxLength: 200 question: type: string minLength: 1 maxLength: 2000 replies: maxItems: 4 type: array items: type: object properties: messageId: type: string minLength: 1 maxLength: 200 text: type: string minLength: 1 maxLength: 8000 at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - messageId - text - at additionalProperties: false description: type: string maxLength: 1200 reason: type: string maxLength: 250 required: - status - question - replies additionalProperties: false providerCheck: type: string enum: - not_attempted - confirmed - unconfirmed - unavailable connectionMethods: default: [] maxItems: 3 type: array items: type: object properties: protocol: type: string enum: - MCP - A2A - WEBMCP environment: type: string enum: - remote_client - browser_session endpointUrl: anyOf: - type: string format: uri - type: 'null' endpointStatus: type: string enum: - not_published - verified documentationUrl: type: string format: uri required: - protocol - environment - endpointUrl - endpointStatus - documentationUrl additionalProperties: false connectionPrompt: type: string minLength: 1 maxLength: 60000 required: - agentId - agentSlug - operationId - operationRevision - providerFamilyRef - rank - selected - name - description - requiredSetup - executionRequirements - executionGuidance - readiness - canStartThread - reasons - uncertainties - providerCheck - connectionMethods - connectionPrompt additionalProperties: false role: type: string enum: - suggested - used required: - type - searchId - agents - role additionalProperties: false - type: object properties: type: type: string const: checkpoint reason: type: string enum: - approval - connection - unavailable - limit - user_control - input text: type: string threadId: type: string required: - type - reason - text additionalProperties: false - type: object properties: type: type: string const: plan presentation: type: object properties: outcome: type: string minLength: 1 maxLength: 1200 timeline: anyOf: - type: string maxLength: 500 - type: 'null' budget: anyOf: - type: string maxLength: 500 - type: 'null' steps: minItems: 1 maxItems: 8 type: array items: type: object properties: title: type: string minLength: 1 maxLength: 160 description: type: string minLength: 1 maxLength: 1200 operationIds: maxItems: 5 type: array items: type: string alternativeOperationIds: maxItems: 5 type: array items: type: string required: - title - description - operationIds additionalProperties: false required: - outcome - timeline - budget - steps additionalProperties: false steps: maxItems: 8 type: array items: type: object properties: stepId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ objective: type: string agentId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ dependsOn: type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ required: - stepId - objective - agentId - dependsOn additionalProperties: false required: - type - steps additionalProperties: false - type: object properties: type: type: string const: handoff agentId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ threadId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ actingAiId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ actRequestId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ url: type: string control: type: string enum: - user - coordinator status: type: string const: thread_created operationId: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ required: - type - agentId - threadId additionalProperties: false - type: object properties: type: type: string const: outcome text: type: string messageIds: type: array items: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9][A-Za-z0-9_.:-]*$ verification: type: string enum: - provider_reported - criteria_checked partial: type: boolean required: - type - text - messageIds - verification - partial additionalProperties: false searchResult: type: object properties: searchId: type: string pattern: ^srch_[a-f0-9-]{36}$ responseId: type: string pattern: ^sresp_[a-f0-9-]{36}$ previousResponseId: anyOf: - type: string pattern: ^sresp_[a-f0-9-]{36}$ - type: 'null' contractVersion: type: string const: search-v3.0 status: type: string enum: - completed - needs_input - no_match response: type: object properties: agents: maxItems: 20 type: array items: type: object properties: agentId: type: string minLength: 1 maxLength: 200 agentSlug: anyOf: - type: string minLength: 1 maxLength: 200 - type: 'null' operationId: type: string minLength: 1 maxLength: 200 operationRevision: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 providerFamilyRef: default: null anyOf: - type: string pattern: ^provider-family:sha256:[a-f0-9]{64}$ - type: 'null' rank: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 selected: type: boolean name: type: string minLength: 1 maxLength: 500 description: anyOf: - type: string maxLength: 8000 - type: 'null' imageUrl: anyOf: - type: string format: uri - type: 'null' avatarUrl: anyOf: - type: string format: uri - type: 'null' requiredSetup: default: null anyOf: - type: object properties: kind: type: string enum: - credential - installation - provider_configuration suppliedBy: type: string enum: - user - provider - runtime description: type: string minLength: 1 maxLength: 500 required: - kind - suppliedBy - description additionalProperties: false - type: 'null' executionRequirements: default: null anyOf: - type: object properties: contractVersion: type: string const: 1.0.0 providerAuthentication: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE mechanisms: maxItems: 20 type: array items: type: string enum: - BEARER - API_KEY - OAUTH2 - HTTP_BASIC - MUTUAL_TLS - SIGNED_REQUEST - SESSION_COOKIE - OPERATION_SECRET_INPUT - UNSPECIFIED placements: maxItems: 20 type: array items: type: string enum: - HEADER - QUERY - COOKIE - BODY - TOOL_ARGUMENT - ENVIRONMENT - AUTH_CONTINUATION scopes: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 evidence: type: string enum: - PROVIDER_DECLARED - PROVIDER_OBSERVED - DERIVED_FROM_VERIFIED_RECEIPT - UNKNOWN required: - state - mechanisms - placements - scopes - evidence additionalProperties: false operationCredentials: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE sensitiveInputNames: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 required: - state - sensitiveInputNames additionalProperties: false runtime: type: object properties: kind: type: string enum: - REMOTE_MCP - LOCAL_STDIO - A2A_JSONRPC - HTTP_JSON - OPENAPI_HTTP - BOUNDED_FETCH - BROWSER - X402_PAYMENT - COMMERCE - UNSUPPORTED package: anyOf: - type: object properties: ecosystem: type: string minLength: 1 maxLength: 40 identifier: type: string minLength: 1 maxLength: 500 version: type: string minLength: 1 maxLength: 200 runtimeProfile: type: string minLength: 1 maxLength: 120 required: - ecosystem - identifier - version - runtimeProfile additionalProperties: false - type: 'null' requiredEnvironmentNames: maxItems: 100 type: array items: type: string minLength: 1 maxLength: 200 required: - kind - package - requiredEnvironmentNames additionalProperties: false payment: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE termsDigest: anyOf: - type: string maxLength: 200 - type: 'null' required: - state - termsDigest additionalProperties: false browser: type: object properties: state: type: string enum: - REQUIRED - NOT_REQUIRED - UNKNOWN - NOT_APPLICABLE sessionKind: anyOf: - type: string enum: - ANONYMOUS - PROVIDER_SESSION - UNKNOWN - type: 'null' required: - state - sessionKind additionalProperties: false providerContract: type: object properties: route: type: string enum: - RESOLVED - MISSING - AMBIGUOUS - UNSAFE - UNSUPPORTED - UNKNOWN inputSchema: type: string enum: - CONCRETE - DIGEST_ONLY - MISSING - UNKNOWN outputSchema: type: string enum: - CONCRETE - DIGEST_ONLY - MISSING - UNKNOWN required: - route - inputSchema - outputSchema additionalProperties: false providerBlockers: maxItems: 20 type: array items: type: object properties: code: type: string enum: - PROVIDER_ROUTE_UNSUPPORTED - PROVIDER_SCHEMA_MISSING - PROVIDER_AUTH_SCHEME_UNSPECIFIED - PROVIDER_METADATA_INCOMPLETE - DARWIN_ADAPTER_UNAVAILABLE - DARWIN_ROUTE_NOT_APPROVED - DARWIN_LOCAL_RUNTIME_UNAVAILABLE - DARWIN_BROWSER_RUNTIME_UNAVAILABLE - DARWIN_PAYMENT_RUNTIME_UNAVAILABLE owner: type: string enum: - PROVIDER - DARWIN required: - code - owner additionalProperties: false derivation: type: object properties: normalizerVersion: type: string const: execution-requirements-v1 sourceRevision: type: string minLength: 1 maxLength: 240 sourceReceiptDigest: anyOf: - type: string maxLength: 200 - type: 'null' completeness: type: string enum: - COMPLETE - PARTIAL derivationKey: type: string pattern: ^sha256:[a-f0-9]{64}$ required: - normalizerVersion - sourceRevision - sourceReceiptDigest - completeness - derivationKey additionalProperties: false required: - contractVersion - providerAuthentication - operationCredentials - runtime - payment - browser - providerContract - providerBlockers - derivation additionalProperties: false - type: 'null' executionGuidance: default: null anyOf: - type: object properties: credentialSummaryCode: type: string minLength: 1 maxLength: 200 credentialSummary: type: string minLength: 1 maxLength: 1000 setupSummaryCode: type: string minLength: 1 maxLength: 200 setupSummary: type: string minLength: 1 maxLength: 1000 recordBlockers: maxItems: 20 type: array items: type: object properties: code: type: string enum: - PROVIDER_ROUTE_UNSUPPORTED - PROVIDER_SCHEMA_MISSING - PROVIDER_AUTH_SCHEME_UNSPECIFIED - PROVIDER_METADATA_INCOMPLETE - DARWIN_ADAPTER_UNAVAILABLE - DARWIN_ROUTE_NOT_APPROVED - DARWIN_LOCAL_RUNTIME_UNAVAILABLE - DARWIN_BROWSER_RUNTIME_UNAVAILABLE - DARWIN_PAYMENT_RUNTIME_UNAVAILABLE owner: type: string enum: - PROVIDER - DARWIN required: - code - owner additionalProperties: false primaryBlockerCode: anyOf: - type: string enum: - PROVIDER_ROUTE_UNSUPPORTED - PROVIDER_SCHEMA_MISSING - PROVIDER_AUTH_SCHEME_UNSPECIFIED - PROVIDER_METADATA_INCOMPLETE - DARWIN_ADAPTER_UNAVAILABLE - DARWIN_ROUTE_NOT_APPROVED - DARWIN_LOCAL_RUNTIME_UNAVAILABLE - DARWIN_BROWSER_RUNTIME_UNAVAILABLE - DARWIN_PAYMENT_RUNTIME_UNAVAILABLE - type: 'null' rendererVersion: type: string const: execution-guidance-v1 required: - credentialSummaryCode - credentialSummary - setupSummaryCode - setupSummary - recordBlockers - primaryBlockerCode - rendererVersion additionalProperties: false - type: 'null' readiness: type: string enum: - ready - authentication_required - recheck_required - unavailable canStartThread: type: boolean canAttemptThread: type: boolean reasons: maxItems: 3 type: array items: type: string maxLength: 250 uncertainties: maxItems: 3 type: array items: type: string maxLength: 250 inquiry: type: object properties: status: type: string enum: - contacting - waiting - following_up - replied - needs_input - no_reply - not_contacted - outcome_unknown fit: type: string enum: - matches - partial - not_fit - unknown expiresAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ threadId: type: string minLength: 1 maxLength: 200 question: type: string minLength: 1 maxLength: 2000 replies: maxItems: 4 type: array items: type: object properties: messageId: type: string minLength: 1 maxLength: 200 text: type: string minLength: 1 maxLength: 8000 at: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - messageId - text - at additionalProperties: false description: type: string maxLength: 1200 reason: type: string maxLength: 250 required: - status - question - replies additionalProperties: false providerCheck: type: string enum: - not_attempted - confirmed - unconfirmed - unavailable connectionMethods: default: [] maxItems: 3 type: array items: type: object properties: protocol: type: string enum: - MCP - A2A - WEBMCP environment: type: string enum: - remote_client - browser_session endpointUrl: anyOf: - type: string format: uri - type: 'null' endpointStatus: type: string enum: - not_published - verified documentationUrl: type: string format: uri required: - protocol - environment - endpointUrl - endpointStatus - documentationUrl additionalProperties: false connectionPrompt: type: string minLength: 1 maxLength: 60000 required: - agentId - agentSlug - operationId - operationRevision - providerFamilyRef - rank - selected - name - description - requiredSetup - executionRequirements - executionGuidance - readiness - canStartThread - reasons - uncertainties - providerCheck - connectionMethods - connectionPrompt additionalProperties: false assessment: type: object properties: outcome: type: string enum: - strong - partial - clarify - no_match - unverified explanation: type: string minLength: 1 maxLength: 2000 required: - outcome - explanation additionalProperties: false relatedSearches: default: [] maxItems: 3 type: array items: type: object properties: query: type: string minLength: 1 maxLength: 200 reason: type: string minLength: 1 maxLength: 250 required: - query - reason additionalProperties: false plan: anyOf: - type: object properties: steps: minItems: 1 maxItems: 8 type: array items: type: object properties: stepId: type: string minLength: 1 maxLength: 200 agentId: type: string minLength: 1 maxLength: 200 operationId: type: string minLength: 1 maxLength: 200 objective: type: string minLength: 1 maxLength: 250 dependsOn: maxItems: 8 type: array items: type: string minLength: 1 maxLength: 200 alternatives: maxItems: 3 type: array items: type: object properties: agentId: type: string minLength: 1 maxLength: 200 operationId: type: string minLength: 1 maxLength: 200 required: - agentId - operationId additionalProperties: false required: - stepId - agentId - operationId - objective - dependsOn additionalProperties: false required: - steps additionalProperties: false - type: 'null' question: anyOf: - type: string minLength: 1 maxLength: 500 - type: 'null' noMatchReason: anyOf: - type: string minLength: 1 maxLength: 500 - type: 'null' overview: anyOf: - type: string maxLength: 32000 - type: 'null' required: - agents - relatedSearches - question - noMatchReason additionalProperties: false searchToken: type: string required: - searchId - responseId - previousResponseId - contractVersion - status - response additionalProperties: false createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ required: - turnId - clientMessageId - message - status - blocks - createdAt - updatedAt additionalProperties: false nextBefore: anyOf: - type: string - type: 'null' eventCursor: type: string required: - turns - nextBefore - eventCursor additionalProperties: false conversationToken: description: Private guest token. Send as X-Assist-Token for subsequent requests. type: string required: - conversationId - status - goal - messages - revisions - latestRevisionId - quote - funding - run - previousRuns - createdAt - updatedAt additionalProperties: false securitySchemes: apiKey: type: apiKey in: header name: x-api-key bearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.