# Meshes API

Meshes API for event ingestion, connections, rules, and workspace management.

Version: 1.0.0

## Servers

```
https://api.meshes.io
```

## Security

### bearerAuth

Machine / server-side authentication using a Bearer token (JWT).

Type: http
Scheme: bearer
Bearer Format: JWT

### publishableKey

Publishable workspace key for client-side event ingestion. Safe to expose in frontend code. Used only for emitting /events endpoints and does not grant access to management APIs.

Type: apiKey
In: header
Name: X-Meshes-Publishable-Key

## Download OpenAPI description

[Meshes API](https://docs.meshes.dev/_bundle/openapi.yaml)

## Connections

Manage connections

### Get Connections

 - [GET /api/v1/connections](https://docs.meshes.dev/openapi/connections/getconnections.md): Get all connections for the organization

### Create Connection

 - [POST /api/v1/connections](https://docs.meshes.dev/openapi/connections/createconnection.md): Create a New Connection

### Get Connection

 - [GET /api/v1/connections/{connection_id}](https://docs.meshes.dev/openapi/connections/getconnection.md): Get Connection by ID

### Update Connection

 - [PUT /api/v1/connections/{connection_id}](https://docs.meshes.dev/openapi/connections/updateconnection.md): Update Connection by ID

### Delete Connection

 - [DELETE /api/v1/connections/{connection_id}](https://docs.meshes.dev/openapi/connections/deleteconnection.md): Delete Connection by ID

### Get Connection Actions

 - [GET /api/v1/connections/{connection_id}/actions](https://docs.meshes.dev/openapi/connections/getconnectionactions.md): Get Connection Actions by ID

### Get Connection Fields

 - [GET /api/v1/connections/{connection_id}/fields](https://docs.meshes.dev/openapi/connections/getconnectionfields.md): Get Connection Fields by Connection ID

### Get Connection Default Mappings

 - [GET /api/v1/connections/{connection_id}/mappings/default](https://docs.meshes.dev/openapi/connections/getconnectiondefaultmappings.md): Get Connection Default Mappings by Connection ID

### Update Connection Default Mappings

 - [PUT /api/v1/connections/{connection_id}/mappings/default](https://docs.meshes.dev/openapi/connections/updateconnectiondefaultmappings.md): Update Connection Default Mappings by Connection ID

## Events

Emit and inspect events

### Get Events

 - [GET /api/v1/events](https://docs.meshes.dev/openapi/events/getevents.md): Get all events for the organization

### Create Event

 - [POST /api/v1/events](https://docs.meshes.dev/openapi/events/createevent.md): Create (emit) a single event

### Create Bulk Events

 - [POST /api/v1/events/bulk](https://docs.meshes.dev/openapi/events/createbulkevent.md): Create (emit) multiple events up to 100 at a time

### Get Event

 - [GET /api/v1/events/{event_id}](https://docs.meshes.dev/openapi/events/getevent.md): Get Event by ID

### Get Event with Payload

 - [GET /api/v1/events/{event_id}/payload](https://docs.meshes.dev/openapi/events/geteventpayload.md): Get Event by ID and include the payload

### Retry Event

 - [POST /api/v1/events/{event_id}/rules/{rule_id}/retry](https://docs.meshes.dev/openapi/events/retryeventrule.md): Retry a single event rule

## Integrations

Browse integration metadata

### Get Integrations

 - [GET /api/v1/integrations](https://docs.meshes.dev/openapi/integrations/getintegrations.md): Get the possible integrations metadata

## Rules

Manage routing rules

### Get Rules

 - [GET /api/v1/rules](https://docs.meshes.dev/openapi/rules/getrules.md): Get all rules for the organization

### Create Rule

 - [POST /api/v1/rules](https://docs.meshes.dev/openapi/rules/createrule.md): Create a new rule

### Get Rule

 - [GET /api/v1/rules/{rule_id}](https://docs.meshes.dev/openapi/rules/getrule.md): Get Rule by ID

### Delete Rule

 - [DELETE /api/v1/rules/{rule_id}](https://docs.meshes.dev/openapi/rules/deleterule.md): Delete Rule by ID

## Sessions

Manage embed sessions

### Create Session

 - [POST /api/v1/sessions](https://docs.meshes.dev/openapi/sessions/createsession.md): Mint a new session token for embedding a workspace, a resource-scoped panel, or a dashboard-only view. launch_page chooses only the initial top-level page; nested pages remain controlled by session route policy and in-app navigation. Requires API key authentication.

### List Sessions

 - [GET /api/v1/sessions](https://docs.meshes.dev/openapi/sessions/listsessions.md): List sessions for a workspace, including additive session_type, resource, and resource_id fields, and supports filtering by status, resource, and resource_id. Requires API key or user authentication with workspace edit access.

### Refresh Session

 - [POST /api/v1/sessions/{sessionId}/refresh](https://docs.meshes.dev/openapi/sessions/refreshsession.md): Refresh an existing session token without minting a new session record while preserving session type and resource scope. Requires API key or user authentication with workspace edit access.

### Revoke Session

 - [DELETE /api/v1/sessions/{sessionId}](https://docs.meshes.dev/openapi/sessions/revokesession.md): Revoke an active session. Requires API key or user authentication with workspace edit access.

## Workspaces

Manage workspaces

### Get Workspaces

 - [GET /api/v1/workspaces](https://docs.meshes.dev/openapi/workspaces/getworkspaces.md): Get all workspaces for the organization

### Create Workspace

 - [POST /api/v1/workspaces](https://docs.meshes.dev/openapi/workspaces/createworkspace.md): Create a New Workspace

### Get Workspace

 - [GET /api/v1/workspaces/{workspace_id}](https://docs.meshes.dev/openapi/workspaces/getworkspace.md): Get Workspace by ID

### Update Workspace

 - [PUT /api/v1/workspaces/{workspace_id}](https://docs.meshes.dev/openapi/workspaces/updateworkspace.md): Update Workspace by ID

### Get Workspace Event Types

 - [GET /api/v1/workspaces/{workspace_id}/event-types](https://docs.meshes.dev/openapi/workspaces/getworkspaceeventtypes.md): Get event types available to a workspace

### Get Workspace Resources

 - [GET /api/v1/workspaces/{workspace_id}/resources](https://docs.meshes.dev/openapi/workspaces/getworkspaceresources.md): Get resources available to a workspace

### Get Workspace Connections

 - [GET /api/v1/workspaces/{workspace_id}/connections](https://docs.meshes.dev/openapi/workspaces/getworkspaceconnections.md): Get all connections for the workspace

### Get Workspace Rules

 - [GET /api/v1/workspaces/{workspace_id}/rules](https://docs.meshes.dev/openapi/workspaces/getworkspacerules.md): Get all rules for the workspace

### Get Workspace Events

 - [GET /api/v1/workspaces/{workspace_id}/events](https://docs.meshes.dev/openapi/workspaces/getworkspaceevents.md): Get all events for the workspace

