Try
Reference

API Reference

Complete API reference for ConvoFlow backend.

ConvoFlow provides a RESTful API for programmatic access. The API is available at /api/v1.

Interactive API Documentation

For interactive API documentation with request/response examples, visit:

http://localhost:8000/docs

Here's an example of hitting a deployed endpoint using Postman:

Postman showing deployed endpoint being tested

Endpoints

GET /api/v1/nodes

List all available nodes

bash
curl http://localhost:8000/api/v1/nodes

GET /api/v1/nodes/{node_name}

Get schema for a specific node

bash
curl http://localhost:8000/api/v1/nodes/querynode

POST /api/v1/nodes/execute

Execute a workflow

bash
curl -X POST http://localhost:8000/api/v1/nodes/execute \
  -H "Content-Type: application/json" \
  -d '{"nodes": {...}, "edges": [...]}'

Full Documentation

Visit the interactive API docs at http://localhost:8000/docs for complete endpoint documentation, request/response schemas, and try-it-out functionality.

Was this page helpful?