> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roark.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an HTTP request definition

> Creates a new HTTP request definition. The signing secret is only returned in this response and cannot be retrieved later.



## OpenAPI

````yaml /api-reference/openapi.documented.json post /v1/http-request-definition
openapi: 3.1.0
info:
  title: Roark Analytics 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: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/http-request-definition:
    post:
      tags:
        - HTTP Request Definition
      summary: Create an HTTP request definition
      description: >-
        Creates a new HTTP request definition. The signing secret is only
        returned in this response and cannot be retrieved later.
      operationId: postV1Http-request-definition
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHttpRequestDefinitionInput'
      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
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Roark from '@roarkanalytics/sdk';


            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });


            const httpRequestDefinition = await
            client.httpRequestDefinition.create({
              scope: 'AGENT_OUTBOUND_DIAL',
              url: 'https://example.com',
            });


            console.log(httpRequestDefinition.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            http_request_definition = client.http_request_definition.create(
                scope="AGENT_OUTBOUND_DIAL",
                url="https://example.com",
            )
            print(http_request_definition.data)
components:
  schemas:
    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
    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)
    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
    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
            - DELETE
          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
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.