Wexa AI
  1. Inbox
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
        GET
    • 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
  1. Inbox

get inbox

GET
https://api.wexa.ai/inbox
Last modified:2025-04-25 11:16:47

Retrieve Inbox for Approval Requests#

Use this endpoint to access the inbox containing all pending, approved, and completed approval requests within your Wexa.ai environment. This centralized platform streamlines coworker approval processes, providing a comprehensive overview of requests to enable efficient collaboration and decision-making.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.wexa.ai/inbox?projectID={{projectID}}&limit=1' \
--header 'x-api-key: {{x-api-key}}'
Response Response Example
{
  "total_count": 1,
  "inbox_requests": [
    {
      "_id": "68067cc5fec812d6a6c5ccee",
      "type": "preview",
      "status": "pending",
      "created_at": 1745255056932.1138,
      "updated_at": 1745255621992.46,
      "agent_id": "68067c7e2d3948612a019214",
      "coworker_id": "68067c49c517ff5238533ccf",
      "coworker_name": "content creator testing",
      "agent_title": "content creator",
      "summary": "Hello there! I'm excited to continue our work together. Could you please provide the preview for execution? Your input is essential for moving forward. Thank you!",
      "execution_id": "adb4f70c-03f6-4615-b377-b09002c53843",
      "projectID": "67fdea40aac77be632954f13",
      "executed_by": "67fdea40aac77be632954f0e",
      "preview": {
        "is_approved": false,
        "modified_inputs_during_preview": [],
        "preview_input": {
          "thoughts": {
            "text": "Create engaging content about Abdul Kalam, focusing on his life, achievements, and legacy.",
            "reasoning": "Abdul Kalam is a significant figure in Indian history, known for his contributions to science and his role as a leader. Highlighting his achievements and values can inspire and educate the audience.",
            "plan": "- Research key aspects of Abdul Kalam's life\n- Highlight his contributions to science and education\n- Emphasize his leadership qualities and vision for India\n- Create content that is informative and inspiring",
            "criticism": "Ensure the content is not only informative but also engaging to capture the audience's interest.",
            "speak": "Creating content about Abdul Kalam will help in spreading awareness about his contributions and inspiring others."
          },
          "skill": {
            "name": "Content creator - Content creation",
            "id": "68063653fc2e1fb8597c775f",
            "input": {
              "content": {
                "title": "The Inspiring Journey of Dr. A.P.J. Abdul Kalam",
                "introduction": "Dr. A.P.J. Abdul Kalam, known as the 'Missile Man of India', was a visionary leader and a renowned scientist who served as the 11th President of India. His life and work continue to inspire millions.",
                "early_life": "Born on October 15, 1931, in Rameswaram, Tamil Nadu, Abdul Kalam came from humble beginnings. His early life was marked by a strong desire to learn and excel.",
                "scientific_contributions": "Kalam played a pivotal role in India's civilian space program and military missile development, earning him the nickname 'Missile Man'. His work in the development of ballistic missile technology and launch vehicle systems was crucial to India's defense capabilities.",
                "presidency": "Serving as the President of India from 2002 to 2007, Kalam was known for his accessibility to the public and his efforts to promote education and innovation.",
                "legacy": "Abdul Kalam's legacy is one of inspiration and dedication to the nation. His vision for India as a developed nation continues to motivate young minds.",
                "conclusion": "Dr. Kalam's life is a testament to the power of dreams and perseverance. His contributions to science and his leadership have left an indelible mark on India and the world."
              }
            }
          }
        },
        "preview_input_schema": {
          "fields": [
            {
              "field_id": "content",
              "label": "content to generated",
              "type": "object",
              "required": true,
              "description": "A JSON object with the data that is to be saved in the execution context and should be generated by an LLM. You can follow the instructions given in the task to generate appropriate json data. This is mandatory and you should provide the data in the format mentioned in the task. If nothing is mentioned, just interpret any relevant data and provide it in the JSON format."
            }
          ]
        },
        "summary": null,
        "timestamp": 1745255616
      },
      "createdAt": 1745255621590.949
    }
  ]
}

Request

Query Params
projectID
string 
required
Example:
{{projectID}}
limit
string 
required
Example:
1
Header Params
x-api-key
string 
required
Example:
{{x-api-key}}

Responses

🟢200get inbox
application/json
Body
total_count
integer 
required
inbox_requests
array [object {15}] 
required
_id
string 
optional
type
string 
optional
status
string 
optional
created_at
number 
optional
updated_at
number 
optional
agent_id
string 
optional
coworker_id
string 
optional
coworker_name
string 
optional
agent_title
string 
optional
summary
string 
optional
execution_id
string 
optional
projectID
string 
optional
executed_by
string 
optional
preview
object 
optional
createdAt
number 
optional
Modified at 2025-04-25 11:16:47
Previous
get files by connector_id
Next
tags