# PipesHub Agents API

**Canonical:** https://apis.io/apis/pipeshub/pipeshub-agents-api/  
**Provider:** PipesHub — https://apis.io/providers/pipeshub/  
**Base URL:** https://app.pipeshub.com/api/v1  
**Documentation:** https://docs.pipeshub.com/developer/api-reference

PipesHub Agents API is one of 51 APIs that [PipesHub](https://apis.io/providers/pipeshub/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 6 JSON Schemas.

Custom AI agents with specialized capabilities and tool integrations

## Operations (24)

| Method | Path | Summary |
|---|---|---|
| GET | `/agents` | List agents |
| POST | `/agents/create` | Create agent |
| GET | `/agents/{agentKey}` | Get agent |
| PUT | `/agents/{agentKey}` | Update agent |
| DELETE | `/agents/{agentKey}` | Delete agent |
| GET | `/agents/conversations/show/archives` | List archived agent conversations grouped by agent |
| GET | `/agents/{agentKey}/conversations/show/archives` | List archived conversations for an agent |
| POST | `/agents/{agentKey}/conversations/attachments/upload` | Upload agent chat attachments |
| DELETE | `/agents/{agentKey}/conversations/attachments/{recordId}` | Delete an agent chat attachment |
| POST | `/agents/{agentKey}/conversations/stream` | Create agent conversation with streaming response |
| POST | `/agents/{agentKey}/conversations/{conversationId}/messages/stream` | Add message to agent conversation with streaming response |
| POST | `/agents/{agentKey}/conversations/{conversationId}/message/{messageId}/regenerate` | Regenerate agent conversation message |
| POST | `/agents/{agentKey}/conversations/{conversationId}/cancel` | Cancel an in-flight agent chat stream |
| POST | `/agents/{agentKey}/conversations/{conversationId}/message/{messageId}/feedback` | Submit feedback for an agent message |
| POST | `/agents/{agentKey}/conversations/{conversationId}/messages` | Add message to agent conversation (non-streaming) |
| POST | `/agents/{agentKey}/conversations/{conversationId}/archive` | Archive an agent conversation |
| POST | `/agents/{agentKey}/conversations/{conversationId}/unarchive` | Unarchive an agent conversation |
| PATCH | `/agents/{agentKey}/conversations/{conversationId}/title` | Update agent conversation title |
| PUT | `/agents/{agentKey}/conversations/{conversationId}/project` | Link or unlink an agent conversation to a project |
| PATCH | `/agents/{agentKey}/conversations/{conversationId}/project-visibility` | Override an agent conversation's project visibility |
| DELETE | `/agents/{agentKey}/conversations/{conversationId}` | Delete an agent conversation |
| GET | `/agents/{agentKey}/conversations/{conversationId}` | Get agent conversation by ID |
| GET | `/agents/{agentKey}/conversations` | List agent conversations |
| POST | `/agents/{agentKey}/conversations` | Create agent conversation (non-streaming) |

## Machine-readable artifacts (9)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/openapi/pipeshub-agents-api-openapi.yml
- **Documentation** — https://docs.pipeshub.com/developer/api-reference
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-get-record-by-id-response-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-record-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-knowledge-hub-nodes-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-agent-create-conversation-request-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-conversation-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/json-schema/pipeshub-create-conversation-request-schema.json
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/pipeshub/refs/heads/main/apis.yml

## Other PipesHub APIs (12)

- [PipesHub AI Models Providers API](https://apis.io/apis/pipeshub/pipeshub-ai-models-providers-api/)
- [PipesHub Authentication Configuration API](https://apis.io/apis/pipeshub/pipeshub-authentication-configuration-api/)
- [PipesHub Configuration Manager API](https://apis.io/apis/pipeshub/pipeshub-configuration-manager-api/)
- [PipesHub Connector API](https://apis.io/apis/pipeshub/pipeshub-connector-api/)
- [PipesHub Connector Configuration API](https://apis.io/apis/pipeshub/pipeshub-connector-configuration-api/)
- [PipesHub Connector Control API](https://apis.io/apis/pipeshub/pipeshub-connector-control-api/)
- [PipesHub Connector Filters API](https://apis.io/apis/pipeshub/pipeshub-connector-filters-api/)
- [PipesHub Connector Instances API](https://apis.io/apis/pipeshub/pipeshub-connector-instances-api/)
- [PipesHub Connector OAuth API](https://apis.io/apis/pipeshub/pipeshub-connector-oauth-api/)
- [PipesHub Connector Registry API](https://apis.io/apis/pipeshub/pipeshub-connector-registry-api/)
- [PipesHub Connectors API](https://apis.io/apis/pipeshub/pipeshub-connectors-api/)
- [PipesHub Conversational Speech API](https://apis.io/apis/pipeshub/pipeshub-conversational-speech-api/)

## Tags

Agents

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/pipeshub/pipeshub-agents-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/pipeshub/.