Skip to main content

Coconut API

The Coconut API provides comprehensive programmatic access to all features of the Coconut development platform, including proposal management, agent orchestration, resource handling, terminal sessions, and AI-powered functionality.

API Overview

The API is organized into the following categories:

Proposals

Manage change proposals and track development tasks

Agents

Configure and orchestrate AI agents

Resources

Handle files, media, and project resources

Terminal

Manage integrated terminal sessions

AI

Access AI chat and completion endpoints

Configuration

Manage project and global settings

Base URL

The API is available at /api/v1 relative to your Coconut instance:
http://localhost:3000/api/v1    # Local instance
https://your-instance.coconut.dev/api/v1    # Hosted instance

Authentication

The Coconut API supports multiple authentication methods:
  • Session Cookie - For browser-based requests
  • Bearer Token - For programmatic API access
  • API Key - For service-to-service communication
Most endpoints require authentication. Make sure to include your credentials in each request.

Getting Started

Explore the API reference using the navigation menu to discover all available endpoints and their parameters.