Quick Start

About the API

Our API is RESTful, fully-featured, and easy to integrate with. You can create draft posts, schedule them, generate AI copy and more. You can use your favorite HTTP/REST library that is available for your programming language to make HTTP calls. You must send json payloads in your requests and expect to get json responses.

---

API flow

The steps below explain the flow of how API requests are handled and how you should be making requests and getting responses back.

Step 1 - Authenticate

Every request must be authenticated, and is rate limited. You must send your API key as part of every request.

More info: Authentication

Step 2 - Send request

Send requests to one of our endpoints providing the required parameters (if mandatory). If sending payloads, we only accept those in a json format.

More info: Endpoints

Step 3 - Get response

Get responses from one of our endpoints. We will always send responses in a json format.

---

Authenticated request sample

Let's try fetching some information about our API user:

cURL

curl --request GET \
     --url https://app.ocoya.com/api/_public/v1/me \
     --header 'X-API-Key: XXXX'

Node.js

const me = await fetch('https://app.ocoya.com/api/_public/v1/me', {
    method: 'GET',
    headers: {
      'Content-type': 'application/json',
      'X-API-Key': 'XXXX'
    }
  })
    .then(res => res.json())
    .catch(e => throw new Error(`An unknown error occurred`))

You should receive a response similar to this:

{
    "id": "cm1uptpss0005r59c2dh8z400",
    "name": "Elon Musk",
    "email": "[e-mail]"
}

That's it! You should now be able to send requests to any of our endpoints successfully.