> ## Documentation Index > Fetch the complete documentation index at: https://docs.peel.sh/llms.txt > Use this file to discover all available pages before exploring further. # List APIs ## OpenAPI ````yaml /openapi.json get /v1/apis openapi: 3.1.0 info: title: Peel API version: '2026-03-21' description: >- Public Peel API for creating APIs from URLs, inspecting them, calling generated endpoints, revising builds, and exporting OpenAPI or MCP definitions. servers: - url: https://api.peel.sh security: [] tags: - name: APIs description: Create, list, inspect, revise, rebuild, and export APIs. - name: Account description: Credits and account usage surfaces used by CLI, REST, and MCP clients. - name: Device Auth description: CLI browser-login device flow helpers. - name: Endpoint Execution description: Execute generated endpoints through a stable API resource. - name: OAuth description: OAuth discovery and token flows for hosted MCP clients. - name: MCP description: Hosted MCP transport and discovery surface. paths: /v1/apis: get: tags: - APIs summary: List APIs operationId: listApis parameters: - in: query name: status schema: type: string - in: query name: limit schema: type: integer minimum: 1 maximum: 100 default: 50 - in: query name: cursor schema: type: string responses: '200': description: Page of APIs. content: application/json: schema: type: object required: - apis properties: apis: type: array items: $ref: '#/components/schemas/PublicApiSummary' next_cursor: oneOf: - type: string - type: 'null' additionalProperties: false '401': $ref: '#/components/responses/Unauthorized' security: - ApiKeyAuth: [] components: schemas: PublicApiSummary: type: object required: - id - url - instructions - name - status - created_at - updated_at - completed_at - endpoint_count - failure - failure_reason_code - links properties: id: type: string format: uuid url: type: string instructions: oneOf: - type: string - type: 'null' name: oneOf: - type: string - type: 'null' status: type: string created_at: type: string format: date-time updated_at: type: string format: date-time completed_at: oneOf: - type: string format: date-time - type: 'null' endpoint_count: type: integer failure: oneOf: - $ref: '#/components/schemas/PublicApiFailure' - type: 'null' failure_reason_code: oneOf: - type: string - type: 'null' binding_id: type: string format: uuid version_id: type: string format: uuid identity: $ref: '#/components/schemas/PublicApiIdentity' links: type: object additionalProperties: type: string additionalProperties: false PublicApiFailure: type: object required: - artifact - category - code - message - non_publishable_reason - recommended_action - refund_reviewable - retryable properties: artifact: $ref: '#/components/schemas/PublicBuildFailureArtifact' description: >- Structured build failure diagnostics for support, billing, and retry decisions. category: type: string description: Coarse public category for the failed build. enum: - access_policy - auth_required - build_timeout - compile_quality - no_supported_content - planner_failure - publish_failure - unknown code: description: >- Compact build failure code, usually matching failure_reason_code on the API record. oneOf: - type: string - type: 'null' message: type: string description: User-facing summary of the failed build. non_publishable_reason: description: >- Stable reason Peel did not publish an API when one is available. Action-flow gates use unsupported_action. Custom artifact publish-gate failures use artifact_publishability_failed; inspect artifact.technical_reason for the precise operator diagnostic. oneOf: - type: string enum: - access_blocked - artifact_publishability_failed - missing_task_fields - product_contract_failed - robots_disallowed - runtime_verification_failed - unsupported_action - type: 'null' recommended_action: type: string description: Recommended next action for the API owner. enum: - contact_support - revise_task - retry_later - try_different_url - wait_or_rebuild refund_reviewable: type: boolean description: Whether this failed build should be considered for refund review. retryable: type: boolean description: Whether retrying or rebuilding is expected to help. additionalProperties: false PublicApiIdentity: type: object required: - api_id - binding_id - version_id properties: api_id: type: string binding_id: oneOf: - type: string - type: 'null' version_id: oneOf: - type: string - type: 'null' additionalProperties: false PublicBuildFailureArtifact: type: object description: >- Structured build failure artifact for failed APIs. Use this for support, billing, retry, and operator diagnostics; runtime endpoint errors use the execution response envelope instead. required: - attempted_strategies - billing_disposition - blocked_policy - evidence_refs - failure_class - retryability - schema_version - stage - suggested_user_action - support_debug_id - technical_reason - user_facing_reason properties: attempted_strategies: type: array description: Build-time strategies attempted before Peel failed closed. items: type: string billing_disposition: type: string description: Billing handling recommended for the failed build. enum: - not_billable - refund_review - operator_review blocked_policy: description: Policy that blocked publication, when the failure is policy-driven. oneOf: - type: string - type: 'null' diagnostic_context: type: object description: >- Optional structured context for capability gates. Present when Peel can expose useful non-publishable diagnostics without publishing a runtime endpoint. properties: action_flow_research: type: object description: >- Deterministic action-flow research gate summary. This is diagnostic only; it does not enable action endpoint publication. required: - action_kind - candidate_count - deterministic_runtime_required - explicit_user_call_required - no_replayable_sequence_reason - policy_blockers - policy_check_status - publication_gate - replayable_evidence_required - request_sequence_count - request_sequences - requires_csrf - requires_session - runtime_transport - sequence_evidence_status - side_effect_class - user_intent_required properties: action_kind: oneOf: - type: string - type: 'null' candidate_count: type: integer minimum: 0 deterministic_runtime_required: oneOf: - type: boolean - type: 'null' explicit_user_call_required: oneOf: - type: boolean - type: 'null' no_replayable_sequence_reason: oneOf: - type: string - type: 'null' policy_blockers: type: array items: type: string policy_check_status: oneOf: - type: string - type: 'null' publication_gate: oneOf: - type: string - type: 'null' replayable_evidence_required: oneOf: - type: boolean - type: 'null' request_sequence_count: type: integer minimum: 0 request_sequences: type: array description: >- Sanitized deterministic request sequence candidates captured during build-time action-flow research. Diagnostic only; not executable until action publication is enabled. items: type: object required: - evidence_ref - fields - method - requires_csrf - requires_session - source - status - step_kind - url_pattern properties: evidence_ref: oneOf: - type: string - type: 'null' fields: type: array items: type: string method: oneOf: - type: string - type: 'null' requires_csrf: oneOf: - type: boolean - type: 'null' requires_session: oneOf: - type: boolean - type: 'null' source: oneOf: - type: string - type: 'null' status: oneOf: - type: number - type: 'null' step_kind: oneOf: - type: string - type: 'null' url_pattern: oneOf: - type: string - type: 'null' additionalProperties: false requires_csrf: oneOf: - type: boolean - type: 'null' requires_session: oneOf: - type: boolean - type: 'null' runtime_transport: oneOf: - type: string - type: 'null' sequence_evidence_status: oneOf: - type: string - type: 'null' side_effect_class: oneOf: - type: string - type: 'null' user_intent_required: oneOf: - type: boolean - type: 'null' additionalProperties: false additionalProperties: false evidence_refs: type: array description: Stable evidence references useful for support/debugging. items: type: string failure_class: type: string description: Stable normalized build failure class. enum: - robots_disallowed - captcha_or_botwall - auth_required - paywall_or_private_data - unsupported_action - evidence_exhausted - no_matching_data - unstable_surface - compile_policy_violation - runtime_verification_failed - build_admission_limited - build_timeout - agent_tool_failure - internal_error retryability: type: string description: Whether retrying the same build is expected to help. enum: - retryable - not_retryable - operator_action_required schema_version: type: integer description: Build failure artifact schema version. enum: - 1 stage: type: string description: Build stage where the terminal failure was recorded. suggested_user_action: type: string description: Suggested next user action for this failed API. enum: - contact_support - revise_task - retry_later - try_different_url - wait_or_rebuild support_debug_id: type: string description: >- Stable identifier to include when contacting support about this failed build. technical_reason: type: string description: >- Precise diagnostic reason for support and operators. For custom artifact publish-gate failures this can include fragments such as singleton_endpoint_returned_collection, endpoint_not_found, missing_field:, or too_few_items_for_collection:. user_facing_reason: type: string description: Short user-facing explanation of the failure. additionalProperties: false responses: Unauthorized: description: Missing or invalid auth. headers: WWW-Authenticate: schema: type: string description: OAuth bearer challenge with MCP resource metadata when available. content: application/json: schema: type: object properties: error: type: string additionalProperties: true securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key ````