Voxworks

https://docs.voxworks.ai
Admin
Voxworks is an enterprise platform for building AI voice assistants that automate customer...
Tokens:75,497
Snippets:767
Trust Score:5.5
Update:4 months ago
Show doc for...
Tokens:
Raw
### Knowledge Base vs Guidelines Example

Source: https://docs.voxworks.ai/scripts/knowledge-base

This example illustrates the difference in content and format between the Knowledge Base (factual data) and Guidelines (behavioral rules).

```json
"Pricing": "On a cents per minute basis"
```

```text
If asked about pricing, be transparent
```

--------------------------------

### Example Descriptions for LLM Data Extraction

Source: https://docs.voxworks.ai/tools/llm/llm-data

Illustrates how to write detailed descriptions for the LLM Data tool to guide extraction. These descriptions specify what to extract and how to format it, with priority over general type rules.

```text
Extract the customer's email address exactly as stated.
Extract the insurance claim number. Exclude policy numbers and phone numbers.
Extract the incident date in YYYY-MM-DD format. Resolve relative dates from the current call date.
Only pass when the caller gives both a date and a time.
```

--------------------------------

### Create Contact Request Example

Source: https://docs.voxworks.ai/api-reference/contacts/create-contact

Example JSON payload for creating a new contact. Ensure all required fields are present.

```json
{
  "phone_number": "0429069971",
  "first_name": "John",
  "last_name": "Smith",
  "email": "john.smith@example.com",
  "title": "Mr"
}
```

--------------------------------

### Flow Step Navigation Example

Source: https://docs.voxworks.ai/flows/steps-flow

This example shows how a Flow Step can navigate to a sub-flow and handle both success and failure outcomes. The 'true' condition leads to 'confirmation_step', while 'false' leads to 'alternative_step'.

```text
Flow Step: Enter Booking Sub-Flow
   Condition: true (success)
   → Next: confirmation_step

   Condition: false (failure)
   → Next: alternative_step
```

--------------------------------

### Tool Step Example

Source: https://docs.voxworks.ai/flows/steps

Demonstrates a Tool step used for checking external service availability, with conditional logic for subsequent actions.

```text
Tool Step: Check calendar availability
   Condition: true (slots available) → Speak options step
   Condition: false (no slots) → Apologize and offer alternative
```

--------------------------------

### Transform Step Field Mapping Example

Source: https://docs.voxworks.ai/automations/field-mapping

Illustrates mapping webhook data to contact fields in a Transform step. This example shows source fields, target fields, and an applied transform.

```text
trigger.phone -> contact.phone_number
trigger.first_name -> contact.first_name
trigger.last_name -> contact.last_name (uppercase)
```

--------------------------------

### Voice Step Example

Source: https://docs.voxworks.ai/flows/steps

Illustrates a typical Voice step configuration, including a prompt and conditional navigation based on user responses.

```text
Voice Step: "Would you like to schedule a demo?"
   Condition: "User agrees" → Booking step
   Condition: "No" → Thank user and say goodbye step
   Condition: "Otherwise" → Loop back to current step
```

--------------------------------

### Create Object Type Request Example

Source: https://docs.voxworks.ai/api-reference/objects/create-object-type

This example demonstrates the structure of a request body to create a new object type. It specifies the type name, display name, description, validation mode, and a custom schema.

```yaml
type_name: property
display_name: Property
description: Property records imported from a CRM
validation_mode: strict
unique_by_contact: false
schema:
  address: string
  bedrooms: number
```

--------------------------------

### Contact Already Exists Response Example

Source: https://docs.voxworks.ai/api-reference/contacts/create-contact

Example JSON response when a contact with the provided phone number already exists.

```json
{
  "success": false,
  "message": "Contact with this phone number already exists"
}
```

--------------------------------

### Create Phone Call Request Example

Source: https://docs.voxworks.ai/api-reference/calls/create-phone-call

This example demonstrates the structure of a request body to create and schedule an outbound phone call. It includes the originating number, script ID, contact details, and an optional scheduled time.

```yaml
from_number: '+61291234567'
script_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
contact:
  phone_number: '0429069971'
  first_name: John
  last_name: Smith
scheduled_time: '2026-02-25T09:00:00Z'
```

--------------------------------

### Example Labels for LLM Data Extraction

Source: https://docs.voxworks.ai/tools/llm/llm-data

Provides examples of labels used to identify specific data points for extraction. These labels should be short and noun-like.

```text
Customer Email
Claim Number
Incident Date
Appointment Time
Customer Sentiment
```

--------------------------------

### Turn Completion Detection Examples

Source: https://docs.voxworks.ai/conversation-dynamics/response-eagerness

Examples of user utterances and their analysis regarding thought completion, influencing AI response timing.

```text
User Says                 | Analysis             | Action    
| ------------------------- | -------------------- | --------- 
| "Yes, that works for me." | Complete sentence    | Respond   
| "I think that..."         | Incomplete thought   | Wait more 
| "Tuesday is good, but"    | Trailing conjunction | Wait more 
| "Hmm, let me think."      | Explicit pause       | Wait more 
```

--------------------------------

### Example Options for LLM Data Enum Type

Source: https://docs.voxworks.ai/tools/llm/llm-data

Shows example options for the 'struct-enum' type in the LLM Data tool. These options define the allowed choices for extraction and should use stable, machine-friendly values.

```text
positive, neutral, negative
eligible, not_eligible, unknown
booked, declined, needs_follow_up
```

--------------------------------

### Variable Notation Example

Source: https://docs.voxworks.ai/flows/variables

This is the user-facing notation for variables, consisting of a namespace and a field path.

```text
{{namespace.path}}
```

--------------------------------

### Voice Step Conditions Example

Source: https://docs.voxworks.ai/flows/overview

Demonstrates how conditions are evaluated for voice steps to determine the next conversational path based on user responses.

```text
Step: "Are you interested in scheduling a demo?"
   Condition: "User expresses interest" → Go to booking flow
   Condition: "User has questions" → Go to FAQ step
   Condition: "Otherwise" → Stay on same step
```

--------------------------------

### Knowledge Base Structure Example

Source: https://docs.voxworks.ai/scripts/knowledge-base

This JSON object demonstrates the key-value structure of the Knowledge Base, where keys are topics and values are the corresponding information.

```json
{
  "Pricing": "On a cents per minute or cost per call basis.",
  "Capacity": "Can handle thousands of calls per day",
  "Use Cases": "Post-Inspection Buyer Follow-Ups, Bulk Database Re-Engagement, Auction Campaign Buyer Reminders, New Listing Alerts, Buyer Requalification / Finance Check-ins",
  "Other Questions": "I don't have an answer for that currently, I'll feed your question back to our team and aim to get a response back to you on it as soon as possible.",
  "Product Features": "Remove all need for prompt engineering by letting users work with familiar, traditional call scripts, Eliminate model selection complexity—our platform hosts and maintains the best AI engines for you, Listen to calls live and capture every conversation as audio and as a transcript, get AI-generated summaries and call evaluations as soon as the call ends—no manual note-taking required, Seamlessly link your CRM and dial contacts directly from the platform—initiate calls with a single click, sync call logs and notes back to your CRM in real time.",
  "Scheduling Times": "Team available Monday to Friday 9am to 5pm."
}
```

--------------------------------

### Fast Effort Example

Source: https://docs.voxworks.ai/conversation-dynamics/thinking-effort

Illustrates a scenario where 'fast' thinking effort is sufficient for a simple confirmation.

```text
User: "Yes, that time works."
Assistant: "Great! I'll send you a confirmation." [fast effort sufficient]
```

--------------------------------

### Keen Eagerness Example

Source: https://docs.voxworks.ai/conversation-dynamics/response-eagerness

Illustrates a scenario where keen eagerness is appropriate, such as a quick confirmation.

```text
Agent: "Would you like me to send you a confirmation email?"
User: "Yes please"
```

--------------------------------

### Normal Eagerness Example

Source: https://docs.voxworks.ai/conversation-dynamics/response-eagerness

Demonstrates a typical conversational turn where the default 'Normal' eagerness is suitable.

```text
Agent: "What brings you to us today?"
User: "I've been looking for..." [moderate response expected]
```

--------------------------------

### Flow Architecture Example

Source: https://docs.voxworks.ai/flows/overview

Illustrates the hierarchical structure of a Voxworks flow, including main flows, sub-flows, steps, and conditions.

```text
Script
   Main Flow (entry point)
       Step 1 (Voice)
          Condition A → Step 2
          Condition B → Step 3
       Step 2 (Voice)
          Condition → Step 3
       Step 3 (Flow) 
           Sub-Flow
               Step 1
               Step 2 → Return to Main Flow
```

--------------------------------

### Webhook URL Example

Source: https://docs.voxworks.ai/tools/webhook

Specify the full endpoint URL, including the protocol, for the webhook call. Variable substitution is supported.

```text
https://example.com/webhooks/inbound-call
```

--------------------------------

### Get List

Source: https://docs.voxworks.ai/llms.txt

Get a list and its contacts.

```APIDOC
## GET /lists/{list_id}

### Description
Get a list and its contacts.

### Method
GET

### Endpoint
/lists/{list_id}

### Parameters
#### Path Parameters
- **list_id** (string) - Required - The ID of the list to retrieve.
```

--------------------------------

### OpenAPI Error Response Example

Source: https://docs.voxworks.ai/api-reference/calls/create-phone-call

Example of an error response structure defined in the OpenAPI specification.

```yaml
content:
  application/json:
    schema:
      $ref: "#/components/schemas/ErrorResponse"
    example:
      success: false
      message: Internal server error
```

--------------------------------

### Voicemail Message Example

Source: https://docs.voxworks.ai/scripts/voicemail-message

An example of a concise voicemail message that identifies the caller, states the purpose, and provides next steps.

```text
Hi, this is Sarah from Voxworks. Please call us
back at 0400-000-000, have a great day!
```

--------------------------------

### Example Guideline: Handling Pricing Questions

Source: https://docs.voxworks.ai/scripts/guidelines

Use this guideline when a user asks about pricing. It directs the assistant to explain that pricing varies and offer a specialist follow-up.

```text
Condition: User asks about pricing or costs
Response: Explain that pricing varies by needs and offer to have a specialist follow up with detailed pricing information
```

--------------------------------

### Call-Start Data Fetching Process

Source: https://docs.voxworks.ai/automations/call-start-data

This diagram outlines the sequence of events when call-start data sourcing is configured. It shows how data is fetched from a source and injected into the assistant's context.

```text
Call starts (inbound or outbound)
  -> Voxworks looks up the contact and their linked objects
  -> Finds the automation with call-start config for this Script
  -> Fetches data from the configured source (CRM API or HTTP endpoint)
  -> Maps the response fields to context keys
  -> Validates required fields
  -> Injects the data into the assistant's context window
  -> Call proceeds
```

--------------------------------

### Example Dynamics Configuration Per Step

Source: https://docs.voxworks.ai/conversation-dynamics/overview

Configure specific dynamics settings like Eagerness, Thinking Effort, and Silence Tolerance for different conversational steps, such as complex questions versus simple confirmations.

```text
Step: Complex questions that require thoughtful consideration from both user and assistant
  - Eagerness: patient (wait for complete thoughts)
  - Thinking Effort: deep (deeper reasoning)
  - Silence Tolerance: patient

Step: Simple confirmation
  - Eagerness: keen (quick yes/no expected)
  - Thinking Effort: fast (straightforward response)
  - Silence Tolerance: hurried
```

--------------------------------

### Get object type by ID

Source: https://docs.voxworks.ai/api-reference/objects/get-object-type-by-id

Fetches a specific object type using its ID. This is a GET request to the /api/v1/object-types/{object_type_id} endpoint.

```APIDOC
## GET /api/v1/object-types/{object_type_id}

### Description
Retrieves a specific object type by its unique identifier.

### Method
GET

### Endpoint
/api/v1/object-types/{object_type_id}

### Parameters
#### Path Parameters
- **object_type_id** (string) - Required - The unique identifier of the object type to retrieve.

### Responses
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **object_type** (object) - Contains the details of the retrieved object type.
  - **id** (string)
  - **type_name** (string)
  - **display_name** (string)
  - **description** (string | null)
  - **schema** (object)
  - **validation_mode** (string) - Enum: 'off', 'warn', 'strict'
  - **unique_by_contact** (boolean)

#### Error Responses
- **401** - Unauthorized: Missing, malformed, or invalid authorization.
- **404** - NotFound: The requested resource was not found or does not belong to your team.
- **429** - RateLimited: Rate limit exceeded.
- **500** - InternalServerError: Internal server error.
```

--------------------------------

### Example Inbound Webhook Payload

Source: https://docs.voxworks.ai/automations/triggers

An example JSON payload that can be sent to an Inbound Webhook URL. Fields from this payload are accessible in the automation pipeline.

```json
{
  "phone": "+61400111222",
  "first_name": "John",
  "last_name": "Doe",
  "crm_id": "12345",
  "notes": "Interested in enterprise plan"
}
```

--------------------------------

### Example Guideline: Handling Emotional Situations

Source: https://docs.voxworks.ai/scripts/guidelines

This guideline addresses user frustration or anger. It instructs the assistant to acknowledge feelings, apologize, and focus on resolution.

```text
Condition: User expresses frustration or anger
Response: Acknowledge their feelings, apologize for any inconvenience, and focus on finding a resolution
```

--------------------------------

### Example Condition Branching Logic

Source: https://docs.voxworks.ai/automations/conditions

Illustrates how a condition step evaluates a field and directs the pipeline flow. The 'Then' path runs if the condition is true, and the 'Otherwise' path runs if it's false. Steps in empty branches are skipped.

```text
... previous steps ...
  |
  v
Condition: call.status = "completed"
  |
  |-- Then:
  |     Step A: Sync to CRM
  |     Step B: Email to contact
  |
  |-- Otherwise:
  |     Step C: SMS to team ("Call failed")
  |
  v
... next steps (always run) ...

```

--------------------------------

### Example SMS Sending Usage

Source: https://docs.voxworks.ai/tools/integrations/sms/sms-send

Demonstrates how to use the SMS sending tool within a conversational flow, including input parameters and conditional logic for success and failure.

```text
Tool Step: Send booking confirmation
   Input: "Your appointment is confirmed for [Calendar - Booking Time - Written]. See you then!"

   Condition: true (success)
   -> Next: confirmation_step
   -> Script: "I've sent you a text with the details."

   Condition: Otherwise (failure)
   -> Next: fallback_step
   -> Script: "I wasn't able to send the text."
```

--------------------------------

### Example Guideline: Handling Technical Questions

Source: https://docs.voxworks.ai/scripts/guidelines

Use this guideline for highly technical user questions that are beyond the assistant's scope. It suggests noting the question and offering a technical specialist contact.

```text
Condition: User asks highly technical questions beyond scope of knowledge
Response: Note their question and offer to have a technical specialist contact them with detailed information
```

--------------------------------

### Get Object Type by Name OpenAPI Specification

Source: https://docs.voxworks.ai/api-reference/objects/get-object-type-by-name

This OpenAPI 3.1.0 specification defines the GET /api/v1/object-types/by-name/{type_name} endpoint. It outlines the request parameters, authentication, and possible responses, including success and error scenarios.

```yaml
openapi: 3.1.0
info:
  title: Voxworks API
  version: 1.0.0
  description: >-
    Public REST API for creating contacts, scheduling calls, retrieving call
    results, managing lists and objects, and receiving automation webhooks.
servers:
  - url: https://api.voxworks.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
  - name: Contacts
  - name: Calls
  - name: Lists
  - name: Objects
  - name: Webhooks
paths:
  /api/v1/object-types/by-name/{type_name}:
    get:
      tags:
        - Objects
      summary: Get object type by name
      operationId: getObjectTypeByName
      parameters:
        - name: type_name
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-z][a-z0-9_]*$
      responses:
        '200':
          description: Object type returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  object_type:
                    $ref: '#/components/schemas/ObjectType'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ObjectType:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        type_name:
          type: string
        display_name:
          type: string
        description:
          type:
            - string
            - 'null'
        schema:
          type: object
          additionalProperties: true
        validation_mode:
          type: string
          enum:
            - 'off'
            - warn
            - strict
        unique_by_contact:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
  responses:
    BadRequest:
      description: Missing or invalid request data.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing, malformed, or invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid:
              value:
                success: false
                message: Invalid API key
    NotFound:
      description: The requested resource was not found or does not belong to your team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: string
        X-RateLimit-Remaining:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.'

```

--------------------------------

### Support Handoff with Greeting Wait

Source: https://docs.voxworks.ai/tools/warm-handoff

Set up a support handoff that waits for the user to acknowledge the connection before proceeding. Includes timeout settings and summary input instructions.

```text
Agent Name: Support
Phone Number: +61412345678
Warm Merge Message: You're now connected with support. They'll help from here.
Wait For User: true
Wait For User Message: Hello, this is support.
Handoff Timeout Seconds: 10
Summary Inputs: Include the caller's name, issue, and any troubleshooting already attempted.
```

--------------------------------

### Get Object Type by Name

Source: https://docs.voxworks.ai/llms.txt

Retrieve an object type by its name.

```APIDOC
## GET /objects/object-types/by-name/{object_type_name}

### Description
Retrieve an object type by its name.

### Method
GET

### Endpoint
/objects/object-types/by-name/{object_type_name}

### Parameters
#### Path Parameters
- **object_type_name** (string) - Required - The name of the object type to retrieve.
```

--------------------------------

### Get Call Status

Source: https://docs.voxworks.ai/llms.txt

Retrieve lightweight lifecycle fields for a call.

```APIDOC
## GET /calls/{call_id}/status

### Description
Retrieve lightweight lifecycle fields for a call.

### Method
GET

### Endpoint
/calls/{call_id}/status

### Parameters
#### Path Parameters
- **call_id** (string) - Required - The ID of the call whose status to retrieve.
```

--------------------------------

### OpenAPI Specification for Get List

Source: https://docs.voxworks.ai/api-reference/lists/get-list

This OpenAPI 3.1.0 specification defines the GET /api/v1/get-list/{list_id} endpoint. It outlines the request parameters, including the list ID, and the structure of successful responses (list details and contacts) as well as various error responses (Unauthorized, NotFound, RateLimited, InternalServerError).

```yaml
openapi: 3.1.0
info:
  title: Voxworks API
  version: 1.0.0
  description: >-
    Public REST API for creating contacts, scheduling calls, retrieving call
    results, managing lists and objects, and receiving automation webhooks.
servers:
  - url: https://api.voxworks.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
  - name: Contacts
  - name: Calls
  - name: Lists
  - name: Objects
  - name: Webhooks
paths:
  /api/v1/get-list/{list_id}:
    get:
      tags:
        - Lists
      summary: Get list
      description: Get a list and its contacts.
      operationId: getList
      parameters:
        - $ref: '#/components/parameters/ListId'
      responses:
        '200':
          description: List returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  list:
                    $ref: '#/components/schemas/List'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    ListId:
      name: list_id
      in: path
      required: true
      schema:
        type: string
      description: Unique list ID.
  schemas:
    List:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        team_id:
          type: string
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/Contact'
    Contact:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        team_id:
          type: string
        phone_number:
          type: string
          example: '+61429069971'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        full_name:
          type:
            - string
            - 'null'
        email:
          type:
            - string
            - 'null'
        object_data:
          type: object
          additionalProperties: true
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid:
              value:
                success: false
                message: Invalid API key
    NotFound:
      description: The requested resource was not found or does not belong to your team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: string
        X-RateLimit-Remaining:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.'

```

--------------------------------

### OpenAPI Specification for Get Object Type by ID

Source: https://docs.voxworks.ai/api-reference/objects/get-object-type-by-id

This OpenAPI 3.1.0 specification defines the GET /api/v1/object-types/{object_type_id} endpoint. It outlines the request parameters, possible responses including success (200) and error codes (401, 404, 429, 500), and the structure of the returned object type schema.

```yaml
openapi: 3.1.0
info:
  title: Voxworks API
  version: 1.0.0
  description: >-
    Public REST API for creating contacts, scheduling calls, retrieving call
    results, managing lists and objects, and receiving automation webhooks.
servers:
  - url: https://api.voxworks.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
  - name: Contacts
  - name: Calls
  - name: Lists
  - name: Objects
  - name: Webhooks
paths:
  /api/v1/object-types/{object_type_id}:
    get:
      tags:
        - Objects
      summary: Get object type by ID
      operationId: getObjectType
      parameters:
        - name: object_type_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Object type returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  object_type:
                    $ref: '#/components/schemas/ObjectType'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    ObjectType:
      type: object
      additionalProperties: true
      properties:
        id:
          type: string
        type_name:
          type: string
        display_name:
          type: string
        description:
          type:
            - string
            - 'null'
        schema:
          type: object
          additionalProperties: true
        validation_mode:
          type: string
          enum:
            - 'off'
            - warn
            - strict
        unique_by_contact:
          type: boolean
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid:
              value:
                success: false
                message: Invalid API key
    NotFound:
      description: The requested resource was not found or does not belong to your team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: string
        X-RateLimit-Remaining:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.'

```

--------------------------------

### Define a Single `run()` Function

Source: https://docs.voxworks.ai/tools/code-step/examples

Ensure your code step contains exactly one top-level `def run():` function. Move any setup code inside this function.

```python
def run():
    flag = True
    return flag
```

--------------------------------

### Get Call Status API Specification

Source: https://docs.voxworks.ai/api-reference/calls/get-call-status

This OpenAPI 3.1 specification defines the GET /api/v1/get-call-status/{call_id} endpoint. It details the request parameters, including the call_id, and the structure of the successful response (200 OK) which includes call lifecycle fields. It also specifies potential error responses (401, 404, 429, 500).

```yaml
openapi: 3.1.0
info:
  title: Voxworks API
  version: 1.0.0
  description: >-
    Public REST API for creating contacts, scheduling calls, retrieving call
    results, managing lists and objects, and receiving automation webhooks.
servers:
  - url: https://api.voxworks.ai
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
  - name: Contacts
  - name: Calls
  - name: Lists
  - name: Objects
  - name: Webhooks
paths:
  /api/v1/get-call-status/{call_id}:
    get:
      tags:
        - Calls
      summary: Get call status
      description: Retrieve lightweight lifecycle fields for a call.
      operationId: getCallStatus
      parameters:
        - $ref: '#/components/parameters/CallId'
      responses:
        '200':
          description: Call status returned.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - call
                properties:
                  success:
                    type: boolean
                    example: true
                  call:
                    $ref: '#/components/schemas/CallStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    CallId:
      name: call_id
      in: path
      required: true
      schema:
        type: string
      description: Unique call ID.
  schemas:
    CallStatus:
      type: object
      properties:
        id:
          type: string
        status:
          type:
            - string
            - 'null'
        progress:
          type:
            - string
            - 'null'
        end_reason:
          type:
            - string
            - 'null'
        duration:
          type:
            - integer
            - 'null'
        scheduled_time:
          type:
            - string
            - 'null'
          format: date-time
        actual_time:
          type:
            - string
            - 'null'
          format: date-time
        end_time:
          type:
            - string
            - 'null'
          format: date-time
        modified_at:
          type:
            - string
            - 'null'
          format: date-time
    ErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
  responses:
    Unauthorized:
      description: Missing, malformed, or invalid authorization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid:
              value:
                success: false
                message: Invalid API key
    NotFound:
      description: The requested resource was not found or does not belong to your team.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimited:
      description: Rate limit exceeded.
      headers:
        Retry-After:
          schema:
            type: string
        X-RateLimit-Limit:
          schema:
            type: string
        X-RateLimit-Remaining:
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Rate limit exceeded
    InternalServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            message: Internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key from Voxworks, sent as `Authorization: Bearer YOUR_API_KEY`.'

```

--------------------------------

### Get Call Status

Source: https://docs.voxworks.ai/api-reference/calls/get-call-status

Retrieve lightweight lifecycle fields for a call by providing its unique ID.

```APIDOC
## GET /api/v1/get-call-status/{call_id}

### Description
Retrieve lightweight lifecycle fields for a call.

### Method
GET

### Endpoint
/api/v1/get-call-status/{call_id}

### Parameters
#### Path Parameters
- **call_id** (string) - Required - Unique call ID.

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **call** (object) - Contains the call status details.
  - **id** (string)
  - **status** (string | null)
  - **progress** (string | null)
  - **end_reason** (string | null)
  - **duration** (integer | null)
  - **scheduled_time** (string | null) - format: date-time
  - **actual_time** (string | null) - format: date-time
  - **end_time** (string | null) - format: date-time
  - **modified_at** (string | null) - format: date-time

#### Error Response
- **401** - Unauthorized: Missing, malformed, or invalid authorization.
- **404** - Not Found: The requested resource was not found or does not belong to your team.
- **429** - Rate Limited: Rate limit exceeded.
- **500** - Internal Server Error: Internal server error.
```

--------------------------------

### Create Object

Source: https://docs.voxworks.ai/llms.txt

Create an object.

```APIDOC
## POST /objects

### Description
Create an object.

### Method
POST

### Endpoint
/objects
```

--------------------------------

### Healthcare Provider Keywords

Source: https://docs.voxworks.ai/conversation-dynamics/keywords

Example keywords for a healthcare provider to accurately transcribe medical terms.

```text
paracetamol
Ibuprofen
referral
GP
```
Tokens:
Raw