​
Ko jums reikia

Prieš siųsdami užklausas, jums reikia:

  1. Ocoya API rakto
  2. Brand ID
  3. Social profile ID, jei norite kurti ar planuoti įrašus

​
Gauti API raktą

Sukurkite arba nukopijuokite API raktą iš savo Ocoya API nustatymų.

Create API key

API raktai skirti naudoti serverio pusėje. Neatskleiskite jų naršyklės JavaScript’e, mobiliųjų programėlių kode ar viešose saugyklose.

​
Bazinis URL

Visuose REST API pavyzdžiuose naudojamas:

https://www.app.ocoya.com/api/_public/v1

​
Pirmoji užklausa

Greičiausias būdas patikrinti, ar jūsų API raktas veikia, – iškviesti /me.

curl -X GET "https://www.app.ocoya.com/api/_public/v1/me" \
  -H "X-API-Key: YOUR_API_KEY"

Jei raktas galioja, API grąžins jūsų naudotojo kontekstą.

{
  "id": "clx354swx0006ghoatnjknv98",
  "name": "Ocoya Support",
  "email": "support@ocoya.com"
}

​
Tipinis publikavimo procesas

1

List brands

Iškvieskite GET /brands ir pasirinkite brand, iš kurio norite publikuoti.

2

Connect social profiles

Jei brand dar neturi prijungtų profilių, iškvieskite POST /social-profiles/connection-url ir naršyklėje atidarykite grąžintą url.

3

List social profiles

Iškvieskite GET /social-profiles?brandId=BRAND_ID, kad rastumėte prijungtų profilių ID.

4

Resolve optional context

Iškvieskite GET /hashtag-libraries?brandId=BRAND_ID, kai AI juodraštis turėtų naudoti išsaugotą grotažymių kontekstą.

5

Create a draft or scheduled post

Iškvieskite POST /post?brandId=BRAND_ID su antrašte (caption), medijos URL, tiksliniais socialinių profilių ID ir neprivalomu scheduledAt.

6

Create an AI draft

Iškvieskite POST /post/ai?brandId=BRAND_ID su prompt, kai norite, kad Ocoya pirmiausia sugeneruotų antraštę.

7

Create an AI campaign

Iškvieskite POST /campaigns?brandId=BRAND_ID, kad eilėje sugeneruotumėte kelių įrašų kampaniją ir iš karto gautumėte GENERATING atsakymą.

8

Manage posts

Naudokite GET /post, PATCH /post/{postId} ir DELETE /post/{postId}, kad peržiūrėtumėte, performatuotumėte arba pašalintumėte įrašus.

​
Kurti įrašą

Naudokite scheduledAt, kai norite suplanuoto įrašo. Praleiskite jį, kai norite juodraščio.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/post?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "caption": "Launching our summer campaign today.",
    "mediaUrls": ["https://example.com/image.jpg"],
    "socialProfileIds": ["SOCIAL_PROFILE_ID"],
    "scheduledAt": "2026-07-01T09:00:00Z"
  }'

​
Prijungti socialinį profilį

Naudokite POST /social-profiles/connection-url, kai jums reikia naršyklės URL naujam socialiniam profiliui prijungti.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/social-profiles/connection-url?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"provider":"instagram"}'

Atidarykite grąžintą url, kai esate prisijungę prie Ocoya.

​
Kurti AI juodraštį

Naudokite POST /post/ai, kai norite, kad Ocoya sugeneruotų antraštę iš prompt prieš sukuriant juodraštį.

Naudokite hashtagLibraryId ir referenceDesignIds, kai norite, kad juodraštis naudotų išsaugotą grotažymių biblioteką arba Studio šablonų kontekstą.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/post/ai?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Write a friendly launch post for our new analytics dashboard.",
    "tone": "friendly",
    "postLength": "medium",
    "socialProfileIds": ["SOCIAL_PROFILE_ID"],
    "hashtagLibraryId": "HASHTAG_LIBRARY_ID",
    "generateImage": true,
    "referenceUrls": ["https://example.com/reference.png"],
    "referenceDesignIds": ["STUDIO_DESIGN_ID"]
  }'

​
Kurti AI kampaniją

Naudokite POST /campaigns, kai norite, kad Ocoya fone sugeneruotų kelių įrašų kampaniją.

Atsakymas grąžinamas iš karto su būsena GENERATING. Naudokite hashtagLibraryId, kai kampanija turėtų naudoti išsaugotą grotažymių biblioteką.

curl -X POST "https://www.app.ocoya.com/api/_public/v1/campaigns?brandId=BRAND_ID" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Summer launch campaign for our ecommerce analytics dashboard, aimed at marketing teams already using spreadsheets. Confident, practical tone.",
    "goal": "launch",
    "duration": 10,
    "count": 6,
    "postLength": "medium",
    "hashtagLibraryId": "HASHTAG_LIBRARY_ID",
    "socialProfileIds": ["SOCIAL_PROFILE_ID"],
    "generateMedia": true
  }'

​
MCP ir REST API

Naudokite REST API backend sistemoms, kurios jau tiksliai žino, ką joms reikia atlikti.

Naudokite MCP, kai norite, kad tokie AI klientai kaip Claude, Codex ar ChatGPT galėtų atrasti ir kviesti Ocoya įrankius po to, kai naudotojas patvirtina OAuth prieigą.