Wexa AI
    Wexa AI
    • Wexa AI
    • Getting Started with Wexa AI
    • Use Cases and Workflows
    • API Reference
    • Tutorials
    • Troubleshooting Guide
    • API Endpoints
      • Project
        • create project
        • Get all projects
        • Get project
        • update project
        • Delete project
      • Agentflows
        • create agentflow
        • get agentflows
        • Get agentflow by projectId and UserId
        • get agentflow by id
        • Add skilled agent to agentflow
        • Update skilled agent
      • Connectors
        • get connectors by projectid
        • get connector by Id
        • Delete a connector
        • connector update status
        • get all available trigger actions
      • Skills
        • create skill
        • get skills
        • get skills by category'
        • get skills by id
        • skills by name
      • Executeflow
        • create executeflow
        • get executions
        • execute agentflow
        • pause executeflow
        • resume execution
        • cancel executeflow
        • get execution by execution id
        • get execution details for monitoring
      • Customer
        • get customer
        • Get credit history
      • Actions
        • create action
        • get action
      • Files
        • upload files
        • get files by fileid
        • get connector by fileid
        • get files by connector_id
      • Inbox
        • get inbox
      • Tags
        • tags
      • Tasks
        • get tasks
        • get task by id
        • Pause running task
        • resume task
        • Stop task
      • Tables
        • create table
        • create database
        • get tables
        • get records list
        • get table names
        • delete record
        • delete a column
      • Dashboard
        • get dashboard
        • refresh dashboard
        • delete component in dashboard
      • Settings
        • get settings
      • Marketplace
        • get all connectors
        • get marketplace coworkers
        • get marketplace coworker by id
      • Coworker schedules
        • get schedules
        • create coworker schedule
        • get schedule coworker by its id
        • update schedule by its id
        • delete schedule by its id
      • Analytics
        • Get analytics
      • Marketplace coworkers
        • hire a coworker
        • check marketplace coworker update
      • Project member
        • project_member

    API Reference

    To use our API, you'll need to authenticate your requests using an API key. This guide will walk you through creating and using API keys.

    Creating an API Key#

    Before making API requests, you must generate an API key from your account:
    1.
    Log in to your Wexa account
    Go to https://app.wexa.ai and log in with your credentials.
    2.
    Open Profile Settings
    In the top-right corner of the Dashboard, click on your profile avatar and select Manage Account from the dropdown menu.
    3.
    Access the API Keys Section
    Within the Manage Account page, navigate to the API Keys tab in the left-hand menu.
    4.
    Create a New API Key
    If you haven't created any keys yet, you’ll see an empty state and a button labeled Create API Key.
    Screenshot from 2025-04-23 20-17-32.png
    Click Create API Key, provide a name for the key (e.g., ProductionKey, TestEnvKey), and confirm the creation.
    5.
    Copy and Store the API Key Securely
    After generation, your new API key will be displayed once. The key is partially masked for security.
    Screenshot from 2025-04-23 20-20-21.png
    ⚠️ Important: Copy your API key immediately and store it securely (e.g., in an environment variable or secrets manager). You won’t be able to retrieve it again after navigating away.

    Using Your API Key#

    Once you have your API key, include it in the headers of all API requests as follows:
    Modified at 2025-04-24 05:10:09
    Previous
    Use Cases and Workflows
    Next
    Tutorials