Convex Management API

Convex Management API

API version: 1.0.0

Auth

Bearer bearer | Bearer bearer | Bearer bearer

Base URL

https://api.convex.dev/v1

Setup

1. Set Authorization header with your Bearer token
2. GET /token_details -- verify access
3. POST /teams/{team_id}/create_project -- create first create_project

Endpoints

20 endpoints across 4 groups. See references/api-spec.lap for full details.

teams

projects

deployments

token_details

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Create a create_project?" -> POST /teams/{team_id}/create_project
• "List all list_projects?" -> GET /teams/{team_id}/list_projects
• "List all list_deployments?" -> GET /projects/{project_id}/list_deployments
• "Create a delete?" -> POST /projects/{project_id}/delete
• "Get project details?" -> GET /projects/{project_id}
• "Get project details?" -> GET /teams/{team_id_or_slug}/projects/{project_slug}
• "Create a create_deployment?" -> POST /projects/{project_id}/create_deployment
• "Create a delete?" -> POST /deployments/{deployment_name}/delete
• "Get deployment details?" -> GET /deployments/{deployment_name}
• "Partially update a deployment?" -> PATCH /deployments/{deployment_name}
• "List all list_deployment_classes?" -> GET /teams/{team_id}/list_deployment_classes
• "List all list_deployment_regions?" -> GET /teams/{team_id}/list_deployment_regions
• "Create a create_deploy_key?" -> POST /deployments/{deployment_name}/create_deploy_key
• "List all list_deploy_keys?" -> GET /deployments/{deployment_name}/list_deploy_keys
• "Create a delete_deploy_key?" -> POST /deployments/{deployment_name}/delete_deploy_key
• "List all token_details?" -> GET /token_details
• "Create a create_custom_domain?" -> POST /deployments/{deployment_name}/create_custom_domain
• "Create a delete_custom_domain?" -> POST /deployments/{deployment_name}/delete_custom_domain
• "List all custom_domains?" -> GET /deployments/{deployment_name}/custom_domains
• "List all list_members?" -> GET /teams/{team_id}/list_members
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP