Crevio Script Runs API

openapi: 3.2.0
info:
  title: Crevio API V1 Script Runs API
  version: 1.0.0
  description: 'API for the Crevio creator platform — a multi-tenant SaaS for digital product sales.

    Uses snake_case keys following Stripe conventions. All resource IDs are string IDs (e.g., "prod_abc123").


    Authentication is a bearer token: `Authorization: Bearer $CREVIO_API_KEY`.

    List endpoints are cursor-paginated with `limit` and `starting_after`.

    Writes accept an `Idempotency-Key` header and are safe to retry.


    Every response carries IETF RateLimit headers (`RateLimit`, `RateLimit-Policy`) so a client can

    self-throttle, and `Retry-After` on a 429. The quota is 600 requests per minute per credential.


    The API is versioned in the URL path (`/v1`). Nothing is removed without in-band warning: a

    deprecated operation is marked `"deprecated": true` here and serves `Deprecation` (RFC 9745),

    `Sunset` (RFC 8594) and `Link; rel="deprecation"` headers for at least six months before it

    stops answering. See https://crevio.co/docs/developer/guides/versioning.'
  contact:
    email: support@crevio.co
    name: Crevio Support
    url: https://crevio.co/docs
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://crevio.co/legal/terms-of-service
servers:
- url: https://api.crevio.co/v1
  description: Production
security:
- ApiKey: []
tags:
- name: ScriptRuns
  description: Run JavaScript on the account's computer, without an agent turn
paths:
  /script_runs:
    post:
      summary: Run a script
      description: 'Runs JavaScript on the account''s computer with bun, with no agent turn, as the key''s owner (account admins only; team keys cannot). `tools..(args)` calls the Crevio API and connected integrations, and the script''s last expression is its `result`. `args` reach the script as the global `args` (and `process.argv`). Files written into the directory named by the global `outputDir` (20 at most, 50 MB each) come back as `artifacts`. A call that needs approval does not run: it resolves to `{pending: true, draft_id, approval}`, the script carries on, and the run lists it in `approvals` and `pending_approval_ids`. Approving it (POST /approvals/{id}/approve) runs that one frozen call, never the script again. `200` when it finished within `wait_seconds`, `202` otherwise: poll GET /script_runs/{id}. At most 4 runs in flight per user and 8 per account (`429`). Needs the `scripts` scope.'
      operationId: createScriptRun
      x-crevio-sdk-method: create
      tags:
      - ScriptRuns
      security:
      - ApiKey: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        description: 'Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.'
        schema:
          type: string
          maxLength: 255
        example: 1f7a4c2e-3b19-4a6d-9f0c-2ac81b5d7e33
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - code
              properties:
                code:
                  type: string
                  maxLength: 100000
                  description: The JavaScript to run.
                args:
                  type: array
                  maxItems: 16
                  items:
                    type: string
                    maxLength: 2000
                  description: Values the script reads from the global `args`.
                timeout_seconds:
                  type: integer
                  minimum: 1
                  maximum: 600
                  default: 300
                  description: How long the script may run.
                wait_seconds:
                  type: integer
                  minimum: 0
                  maximum: 90
                  default: 0
                  description: Hold the response until the script finishes, up to this many seconds.
      responses:
        '200':
          description: The script finished within wait_seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptRun'
        '202':
          description: The script is still queued or running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptRun'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: ask
      x-crevio-locked: true
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.scriptRuns.create(<value>);\n\n  console.log(result);\n}\n\nrun();"
  /script_runs/{id}:
    get:
      summary: Get script run
      description: A script run's status, and once it finished its `result`, `output`, `calls` and `artifacts`. Needs the `scripts` scope.
      operationId: getScriptRun
      x-crevio-sdk-method: get
      tags:
      - ScriptRuns
      security:
      - ApiKey: []
      parameters:
      - name: id
        in: path
        required: true
        description: Script run id (srun_...)
        schema:
          type: string
      responses:
        '200':
          description: The script run
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptRun'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: allow
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.scriptRuns.get({\n    id: \"<id>\",\n  });\n\n  console.log(result);\n}\n\nrun();"
  /script_runs/{id}/cancel:
    post:
      summary: Cancel script run
      description: Cancels a script run that has not started. A running script runs to its end or its timeout (`409 run_not_cancellable`).
      operationId: cancelScriptRun
      x-crevio-sdk-method: cancel
      tags:
      - ScriptRuns
      security:
      - ApiKey: []
      parameters:
      - name: id
        in: path
        required: true
        description: Script run id (srun_...)
        schema:
          type: string
      - name: Idempotency-Key
        in: header
        required: false
        description: 'Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.'
        schema:
          type: string
          maxLength: 255
        example: 1f7a4c2e-3b19-4a6d-9f0c-2ac81b5d7e33
      responses:
        '200':
          description: The cancelled run
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScriptRun'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      x-crevio-approval: ask
      x-codeSamples:
      - lang: typescript
        label: Typescript (SDK)
        source: "import { Crevio } from \"@crevio/sdk\";\n\nconst crevio = new Crevio({\n  apiKey: process.env[\"CREVIO_API_KEY\"] ?? \"\",\n});\n\nasync function run() {\n  const result = await crevio.scriptRuns.cancel({\n    id: \"<id>\",\n  });\n\n  console.log(result);\n}\n\nrun();"
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: forbidden
              message: You do not have permission to perform this action
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: bad_request
              message: The request was malformed or contained invalid parameters
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: authentication_required
              message: You did not provide an API key.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: resource_missing
              message: The requested resource was not found
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    TooManyRequests:
      description: 'Rate limit exceeded — 600 requests per minute per owner on the free tier: every API key and OAuth token one person holds on an account shares one budget, and the account''s team keys share another. Retry after the number of seconds in `Retry-After`.'
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: rate_limit_exceeded
              message: Too many requests. Please retry later.
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: api_error
              code: internal_error
              message: An unexpected error occurred
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    UnprocessableEntity:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: validation_error
              code: validation_failed
              message: Email is required
              errors:
                email:
                - can't be blank
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
  headers:
    Sunset:
      description: Present only on a deprecated operation. HTTP-date (RFC 8594) after which the operation stops responding. Always at least six months after `Deprecation`.
      schema:
        type: string
        examples:
        - Thu, 01 Oct 2026 00:00:00 GMT
    RequestId:
      description: Unique id for this request. Quote it when reporting a problem.
      schema:
        type: string
        examples:
        - 8fe045fe-cb8a-4407-a44d-5df60385e522
    DeprecationLink:
      description: Present only on a deprecated operation. `<url>; rel="deprecation"` pointing at the migration notes.
      schema:
        type: string
        examples:
        - <https://crevio.co/docs/developer/guides/versioning>; rel="deprecation"
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        examples:
        - 11
    Deprecation:
      description: Present only on a deprecated operation. Structured-field date (RFC 9745) — `@` followed by the Unix timestamp at which the operation became deprecated.
      schema:
        type: string
        examples:
        - '@1775001600'
    RateLimit:
      description: 'Remaining quota for the current window, as an IETF structured field: `"default";r=<remaining>;t=<seconds until reset>`.'
      schema:
        type: string
        examples:
        - '"default";r=596;t=11'
    RateLimitPolicy:
      description: 'The quota this credential is subject to: `"default";q=<requests>;w=<window seconds>`.'
      schema:
        type: string
        examples:
        - '"default";q=600;w=60'
  schemas:
    ScriptRun:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        status:
          type: string
          enum:
          - queued
          - in_progress
          - completed
          - failed
          - cancelled
          - timed_out
        result:
          description: The script's last expression, as JSON.
        output:
          type:
          - string
          - 'null'
          description: 'What the script printed: its start and end when long, with the cut marked.'
        error:
          type:
          - string
          - 'null'
        args:
          type: array
          items:
            type: string
        calls:
          type: array
          items:
            type: object
          description: 'Every tool call the script made, in order: `{role, status, read_only, error_code, approval_id}`. A 202 call did not run and names its approval.'
        approvals:
          type: array
          items:
            $ref: '#/components/schemas/Approval'
          description: What the script's gated calls froze, as each stands now. Approving one runs that call, never the script again.
        pending_approval_ids:
          type: array
          items:
            type: string
          description: 'Approvals still waiting for a decision: POST /approvals/{id}/approve or /deny.'
        artifacts:
          type: array
          items:
            $ref: '#/components/schemas/Artifact'
          description: Files the script wrote to `outputDir`.
        timeout_seconds:
          type: integer
        started_at:
          type:
          - string
          - 'null'
        completed_at:
          type:
          - string
          - 'null'
        created_at:
          type: string
          format: date-time
      required:
      - object
      - id
      - status
      - result
      - output
      - error
      - args
      - calls
      - approvals
      - pending_approval_ids
      - artifacts
      - timeout_seconds
      - started_at
      - completed_at
      - created_at
    Approval:
      type: object
      properties:
        object:
          type: string
          enum:
          - approval
        id:
          type: string
        approval_id:
          type: string
        status:
          type: string
          description: '`pending_approval` waits for a person. It ends `executed` (see `result`), `failed` (see `error`) or `denied` (see `reason`).'
          enum:
          - draft
          - pending_approval
          - approved
          - executed
          - failed
          - denied
        kind:
          type: string
          enum:
          - pipedream
          - composio
          - rest
          - mcp
          - native
          - saved_tool
          - vault
          - elicitation
        action_type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        app_slug:
          type:
          - string
          - 'null'
        tool_name:
          type:
          - string
          - 'null'
        result:
          type:
          - object
          - 'null'
        error:
          type:
          - string
          - 'null'
        reason:
          type:
          - string
          - 'null'
        chat_id:
          type:
          - string
          - 'null'
        created_at:
          type: string
        resolved_at:
          type:
          - string
          - 'null'
      required:
      - object
      - id
      - approval_id
      - status
      - kind
      - action_type
      - title
      - app_slug
      - tool_name
      - result
      - error
      - reason
      - chat_id
      - created_at
      - resolved_at
    Artifact:
      type: object
      properties:
        object:
          type: string
        id:
          type: string
        filename:
          type: string
        content_type:
          type:
          - string
          - 'null'
        size:
          type: integer
      required:
      - object
      - id
      - filename
      - content_type
      - size
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
              - api_error
              - invalid_request_error
              - validation_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            errors:
              type: object
            doc_url:
              type: string
          required:
          - type
          - message
      required:
      - error
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key in the format: Bearer {api_token}'
externalDocs:
  description: Crevio developer documentation
  url: https://crevio.co/docs/developer
x-mint:
  mcp:
    enabled: true
x-api-lifecycle:
  current_major_version: v1
  versioning_scheme: URL path
  deprecation_policy_url: https://crevio.co/docs/developer/guides/versioning
  minimum_notice_days: 183
  deprecation_headers:
  - Deprecation
  - Sunset
  - Link