> ## Documentation Index > Fetch the complete documentation index at: https://docs.canary.effectiveai.app/llms.txt > Use this file to discover all available pages before exploring further. # Call an app API route > Send one request to a deployed app’s own API, under `/api/`, signed in as you, and return its response. Use it to test the app’s backend without a browser; the app’s sign-in token never leaves Effective. You act as yourself: the app sees your user, and with an API key its requests to Effective stay within the key’s grants and end when the key does. The request is not retried; whether repeating it is safe depends on the app, including after 502 `app_unreachable`. Needs `publish` permission on the app. ## OpenAPI ````yaml /openapi.json post /apps/{appId}/calls openapi: 3.0.3 info: title: Effective API version: 2.0.0 description: The public Effective REST API. Authenticate using an Effective API key. servers: - url: https://api.canary.effectiveai.app/api/v2 description: Canary security: - bearerAuth: [] paths: /apps/{appId}/calls: post: tags: - Apps summary: Call an app API route description: >- Send one request to a deployed app’s own API, under `/api/`, signed in as you, and return its response. Use it to test the app’s backend without a browser; the app’s sign-in token never leaves Effective. You act as yourself: the app sees your user, and with an API key its requests to Effective stay within the key’s grants and end when the key does. The request is not retried; whether repeating it is safe depends on the app, including after 502 `app_unreachable`. Needs `publish` permission on the app. operationId: callApp parameters: - schema: type: string maxLength: 63 pattern: ^app-[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$ description: >- App ID: `app-` followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters. required: true description: >- App ID: `app-` followed by lowercase letters, digits and hyphens, ending in a letter or digit. It is part of the app’s hostname, so your organization’s subdomain and the ID together must fit 63 characters. name: appId in: path requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/V2AppCallCreate' responses: '200': description: The app’s response, whatever its status. content: application/json: schema: $ref: '#/components/schemas/V2AppCall' '400': description: Invalid request or cursor. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '403': description: >- You lack the permission this needs on the app, or are a read-only member. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '404': description: 'app_not_found: missing, archived, or not an app you can open.' content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '413': description: JSON request body exceeds 64 KiB. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '415': description: Content-Type must be application/json. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '502': description: >- app_unreachable: the app timed out or could not be reached; nothing says whether it ran the request. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' '503': description: Temporarily unavailable; retry later. content: application/json: schema: $ref: '#/components/schemas/V2CodedError' security: - bearerAuth: [] components: schemas: V2AppCallCreate: type: object properties: method: type: string enum: - GET - POST - PUT - PATCH - DELETE path: type: string minLength: 5 maxLength: 2048 pattern: ^\/api\/ description: >- Path and query on the app, under `/api/`, such as `/api/notes?limit=5`. body: nullable: true description: JSON body to send; not allowed with GET. Sent as `application/json`. required: - method - path additionalProperties: false V2AppCall: type: object properties: status: type: integer description: HTTP status the app returned. Redirects are not followed. contentType: type: string nullable: true description: Content-Type the app returned, or null. body: type: string description: Response body as text, at most 64 KiB. truncated: type: boolean description: True when the response was longer than `body`. required: - status - contentType - body - truncated additionalProperties: false V2CodedError: allOf: - $ref: '#/components/schemas/V2Error' - type: object properties: code: type: string minLength: 1 description: Stable error code. Clients must tolerate unknown future codes. details: type: array items: type: object properties: location: type: string enum: - path - query - header - body path: type: array items: type: string maxLength: 64 maxItems: 12 code: type: string enum: - required - invalid_type - invalid_value - unknown_field message: type: string minLength: 1 maxLength: 200 required: - location - path - code - message minItems: 1 maxItems: 20 description: Bounded safe validation issues; may omit some invalid fields. requestId: type: string minLength: 1 maxLength: 128 description: >- Existing server correlation for this HTTP attempt, when available. dataset: type: string enum: - naic - osha description: Dataset needed for dataset_not_enabled. businessCode: type: string description: The rater’s own refusal code, for business_rejection. violations: type: array items: type: object properties: code: type: string description: Authored or built-in constraint code message: type: string description: Authored message for the failed constraint path: type: string description: Input path of the offending value; empty for the request value: nullable: true description: Offending input value, size-bounded by the runtime constraint: type: string description: The constraint the value failed, as text cite: type: string nullable: true description: >- Filing citation of the constraint, when the source cites one required: - code - message - path - value - constraint - cite additionalProperties: false maxItems: 256 description: >- Each input constraint the submission failed, for invalid_inputs and business_rejection. violationsTruncated: type: boolean description: >- True when the rater reported more violations than violations holds. executionId: type: string description: >- The recorded execution of a failed rating, for rater rating failures. accessUrl: type: string nullable: true format: uri description: >- Where to add the product to your account, for product_access_required. required: - code V2Error: type: object properties: error: type: string minLength: 1 description: Human-readable explanation of the failure. required: - error securitySchemes: bearerAuth: type: http scheme: bearer description: 'Effective API key. Send Authorization: Bearer sk-eai-...' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.