# Yumeru API

Version: 1.0.0

## Security

### BearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Yumeru API](https://api-docs.yumeru.ai/_spec/openapi.yaml)

## Index

### /

 - [GET /](https://api-docs.yumeru.ai/openapi/index/paths/~1/get.md)

## Health

### /health

 - [GET /health](https://api-docs.yumeru.ai/openapi/health/paths/~1health/get.md)

## Usage

### Get usage stats for an organization

 - [GET /usage/{organizationId}](https://api-docs.yumeru.ai/openapi/usage/paths/~1usage~1%7Borganizationid%7D/get.md): Get usage stats for a specific organization

### Get weekly usage for an organization

 - [GET /usage/{organizationId}/weekly](https://api-docs.yumeru.ai/openapi/usage/paths/~1usage~1%7Borganizationid%7D~1weekly/get.md): Get weekly usage for a specific organization

### Get quota overview for an organization

 - [GET /usage/{organizationId}/quotas](https://api-docs.yumeru.ai/openapi/usage/paths/~1usage~1%7Borganizationid%7D~1quotas/get.md): Get quota overview for a specific organization

## Agents

### Create a new agent

 - [POST /organizations/{organizationId}/agents](https://api-docs.yumeru.ai/openapi/agents/paths/~1organizations~1%7Borganizationid%7D~1agents/post.md): Create a new agent for a specific organization

### Get agent details

 - [GET /agents/{agentId}](https://api-docs.yumeru.ai/openapi/agents/paths/~1agents~1%7Bagentid%7D/get.md): Get details for a specific agent

### Update agent details

 - [PUT /agents/{agentId}](https://api-docs.yumeru.ai/openapi/agents/paths/~1agents~1%7Bagentid%7D/put.md): Update the details of a specific agent

### Delete an agent

 - [DELETE /agents/{agentId}](https://api-docs.yumeru.ai/openapi/agents/paths/~1agents~1%7Bagentid%7D/delete.md): Delete a specific agent

### List agents

 - [GET /agents](https://api-docs.yumeru.ai/openapi/agents/paths/~1agents/get.md): List all agents for a specific organization

### Web simulate an agent

 - [POST /agents/{agentId}/web-simulate](https://api-docs.yumeru.ai/openapi/agents/paths/~1agents~1%7Bagentid%7D~1web-simulate/post.md): Web simulate a specific agent

### Create a new demo link

 - [POST /organizations/{organizationId}/agents/{agentId}/demo](https://api-docs.yumeru.ai/openapi/agents/paths/~1organizations~1%7Borganizationid%7D~1agents~1%7Bagentid%7D~1demo/post.md): Create a new demo link for a specific agent

### Archive an agent

 - [POST /agents/{agentId}/archive](https://api-docs.yumeru.ai/openapi/agents/paths/~1agents~1%7Bagentid%7D~1archive/post.md): Archive a specific agent

## Campaigns

### Create a new campaign

 - [POST /organizations/{organizationId}/campaigns](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns/post.md): Create a new campaign for a specific organization

### List campaigns

 - [GET /organizations/{organizationId}/campaigns](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns/get.md): List all campaigns for a specific organization

### Get campaign details

 - [GET /organizations/{organizationId}/campaigns/{campaignId}](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D/get.md): Get details for a specific campaign

### Update campaign details

 - [PATCH /organizations/{organizationId}/campaigns/{campaignId}](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D/patch.md): Update the details of a specific campaign

### Delete a campaign

 - [DELETE /organizations/{organizationId}/campaigns/{campaignId}](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D/delete.md): Delete a specific campaign

### Update campaign status

 - [POST /organizations/{organizationId}/campaigns/{campaignId}/status](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1status/post.md): Update the status of a specific campaign

### Import contacts

 - [POST /organizations/{organizationId}/campaigns/{campaignId}/contacts](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1contacts/post.md): Import contacts for a specific campaign

### Get campaign contacts

 - [GET /organizations/{organizationId}/campaigns/{campaignId}/contacts](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1contacts/get.md): Get all contacts for a specific campaign

### Get call details

 - [GET /organizations/{organizationId}/campaigns/{campaignId}/calls/{callId}](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1calls~1%7Bcallid%7D/get.md): Get details for a specific call

### Get calls by target ID

 - [GET /organizations/{organizationId}/campaigns/{campaignId}/targets/{targetId}/calls](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1targets~1%7Btargetid%7D~1calls/get.md): Get all calls for a specific target

### Export campaign contacts

 - [GET /organizations/{organizationId}/campaigns/{campaignId}/export](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1export/get.md): Export all contacts for a specific campaign

### Archive a campaign

 - [POST /organizations/{organizationId}/campaigns/{campaignId}/archive](https://api-docs.yumeru.ai/openapi/campaigns/paths/~1organizations~1%7Borganizationid%7D~1campaigns~1%7Bcampaignid%7D~1archive/post.md): Archive a specific campaign

## Meetings

### Get booked meetings

 - [GET /meetings](https://api-docs.yumeru.ai/openapi/meetings/paths/~1meetings/get.md): Get all booked meetings for a specific organization

## Webhooks

### Create a new webhook for an agent

 - [POST /agents/{agentId}/webhooks](https://api-docs.yumeru.ai/openapi/webhooks/paths/~1agents~1%7Bagentid%7D~1webhooks/post.md): Create a new webhook for an agent

### List all webhooks for an agent

 - [GET /agents/{agentId}/webhooks](https://api-docs.yumeru.ai/openapi/webhooks/paths/~1agents~1%7Bagentid%7D~1webhooks/get.md): List all webhooks for an agent

### Get a webhook by ID for an agent

 - [GET /agents/{agentId}/webhooks/{webhookId}](https://api-docs.yumeru.ai/openapi/webhooks/paths/~1agents~1%7Bagentid%7D~1webhooks~1%7Bwebhookid%7D/get.md): Get a webhook by ID for an agent

### Update a webhook by ID for an agent

 - [PUT /agents/{agentId}/webhooks/{webhookId}](https://api-docs.yumeru.ai/openapi/webhooks/paths/~1agents~1%7Bagentid%7D~1webhooks~1%7Bwebhookid%7D/put.md): Update a webhook by ID for an agent

### Delete a webhook by ID for an agent

 - [DELETE /agents/{agentId}/webhooks/{webhookId}](https://api-docs.yumeru.ai/openapi/webhooks/paths/~1agents~1%7Bagentid%7D~1webhooks~1%7Bwebhookid%7D/delete.md): Delete a webhook by ID for an agent