find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/roark:roark-http-request-definition-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Roark Analytics HTTP Request Definition API
  description: The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform.
  version: 1.0.0
servers:
- description: Production
  url: https://api.roark.ai
security:
- Bearer: []
tags:
- name: HTTP Request Definition
paths:
  /v1/http-request-definition:
    get:
      responses:
        '200':
          description: List of HTTP request definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/HttpRequestDefinitionResponse'
                  pagination:
                    type: object
                    properties:
                      total:
                        type: number
                        description: Total number of items
                      hasMore:
                        type: boolean
                        description: Whether there are more items to fetch
                      nextCursor:
                        type:
                        - string
                        - 'null'
                        description: Cursor for the next page of items
                    required:
                    - total
                    - hasMore
                    - nextCursor
                required:
                - data
                - pagination
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: getV1Http-request-definition
      tags:
      - HTTP Request Definition
      summary: List HTTP request definitions
      description: Returns a paginated list of HTTP request definitions for the authenticated project.
      parameters:
      - in: query
        name: limit
        schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 20
          description: 'Maximum number of definitions to return (default: 20, max: 50)'
      - in: query
        name: after
        schema:
          type: string
          description: Cursor for pagination - definition ID to start after
    post:
      responses:
        '201':
          description: The created HTTP request definition with signing secret
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/HttpRequestDefinitionCreateResponse'
                required:
                - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: postV1Http-request-definition
      tags:
      - HTTP Request Definition
      summary: Create HTTP request definition
      description: Creates a new HTTP request definition. The signing secret is only returned in this response and cannot be retrieved later.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHttpRequestDefinitionInput'
  /v1/http-request-definition/{definitionId}:
    get:
      responses:
        '200':
          description: The requested HTTP request definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/HttpRequestDefinitionResponse'
                required:
                - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: getV1Http-request-definitionByDefinitionId
      tags:
      - HTTP Request Definition
      summary: Get HTTP request definition by ID
      description: Returns a specific HTTP request definition by its ID.
      parameters:
      - name: definitionId
        in: path
        required: true
        description: The ID of the HTTP request definition to retrieve
        schema:
          type: string
    put:
      responses:
        '200':
          description: The updated HTTP request definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/HttpRequestDefinitionResponse'
                required:
                - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: putV1Http-request-definitionByDefinitionId
      tags:
      - HTTP Request Definition
      summary: Update HTTP request definition
      description: Updates an existing HTTP request definition.
      parameters:
      - name: definitionId
        in: path
        required: true
        description: The ID of the HTTP request definition to update
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHttpRequestDefinitionInput'
components:
  schemas:
    HttpRequestDefinitionResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: HTTP request definition ID
        scope:
          type: string
          enum:
          - AGENT_OUTBOUND_DIAL
          description: Scope of the HTTP request definition
        description:
          type:
          - string
          - 'null'
          description: Description of the HTTP request definition
        url:
          type: string
          description: URL for the HTTP request
        method:
          type: string
          enum:
          - POST
          - PUT
          - PATCH
          - GET
          description: 'HTTP method: POST, PUT, PATCH, or GET'
        body:
          type:
          - string
          - 'null'
          description: Request body as a string
        parsedBody:
          anyOf:
          - type: object
            additionalProperties: {}
          - type: string
          - type: 'null'
          description: Parsed body as a JSON object if valid JSON, otherwise the raw string
        headers:
          type: object
          additionalProperties:
            type: string
          description: Request headers as key-value pairs
        isConfigManaged:
          type: boolean
          description: 'Whether this definition is managed by config-as-code. A managed definition is reconciled from your config: PUT returns 409, and changes belong in the config file (or detach it first).'
        createdAt:
          type: string
          description: Creation timestamp
        updatedAt:
          type: string
          description: Last update timestamp
      required:
      - id
      - scope
      - description
      - url
      - method
      - body
      - parsedBody
      - headers
      - isConfigManaged
      - createdAt
      - updatedAt
      description: HTTP request definition
    CreateHttpRequestDefinitionInput:
      type: object
      properties:
        scope:
          type: string
          enum:
          - AGENT_OUTBOUND_DIAL
          description: 'Scope: AGENT_OUTBOUND_DIAL'
        url:
          type: string
          format: uri
          description: URL for the HTTP request
        description:
          type:
          - string
          - 'null'
          description: Description of the HTTP request definition
        method:
          type: string
          enum:
          - POST
          - PUT
          - PATCH
          - GET
          default: POST
          description: 'HTTP method (default: POST)'
        body:
          anyOf:
          - type: string
          - type: object
            additionalProperties: {}
          - type: 'null'
          description: Request body template. Accepts a JSON object or a string with placeholders like {{phoneNumberToDial}}. Objects are serialized to JSON for storage.
        headers:
          type: object
          additionalProperties:
            type: string
          description: Request headers as key-value pairs
      required:
      - scope
      - url
      description: Input for creating an HTTP request definition
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
          - validation
          - authentication
          - forbidden
          - not_found
          - conflict
          - payment_required
          - rate_limit
          - internal
          description: The error type category
          examples:
          - validation
          - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
          - invalid_parameter
          - missing_required_field
          - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
          - The request was invalid
          - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
          - email
          - user_id
        details:
          description: Additional error context information
      required:
      - type
      - code
      - message
    HttpRequestDefinitionCreateResponse:
      allOf:
      - $ref: '#/components/schemas/HttpRequestDefinitionResponse'
      properties:
        signingSecret:
          type: string
          description: Signing secret (only returned on creation)
      required:
      - signingSecret
      description: HTTP request definition with signing secret (returned on creation)
    UpdateHttpRequestDefinitionInput:
      type: object
      properties:
        url:
          type: string
          format: uri
          description: URL for the HTTP request
        description:
          type:
          - string
          - 'null'
          description: Description of the HTTP request definition
        method:
          type: string
          enum:
          - POST
          - PUT
          - PATCH
          - GET
          description: 'HTTP method: POST, PUT, PATCH, or GET'
        body:
          anyOf:
          - type: string
          - type: object
            additionalProperties: {}
          - type: 'null'
          description: Request body template. Accepts a JSON object or a string with placeholders like {{phoneNumberToDial}}. Objects are serialized to JSON for storage.
        headers:
          type: object
          additionalProperties:
            type: string
          description: Request headers as key-value pairs
      description: Input for updating an HTTP request definition
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT