​
Czego potrzebujesz

Zanim wyślesz zapytania, potrzebujesz:

  1. Klucza Ocoya API
  2. ID brandu
  3. ID profili społecznościowych, jeśli chcesz tworzyć lub planować posty

​
Zdobądź API Key

Utwórz lub skopiuj API key w ustawieniach Ocoya API.

Create API key

API keys są przeznaczone do użycia po stronie serwera. Nie ujawniaj ich w JavaScript w przeglądarce, aplikacjach mobilnych ani publicznych repozytoriach.

​
Base URL

Wszystkie przykłady REST API używają:

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

​
Wyślij swoje pierwsze zapytanie

Najszybszy sposób, żeby sprawdzić, czy twój API key działa, to wywołać /me.

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

Jeśli klucz jest prawidłowy, API zwróci twój kontekst użytkownika.

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

​
Typowy przepływ publikacji

1

List brands

Wywołaj GET /brands i wybierz brand, z którego chcesz publikować.

2

Connect social profiles

Jeśli brand nie ma jeszcze podłączonych profili, wywołaj POST /social-profiles/connection-url i otwórz zwrócony url w przeglądarce.

3

List social profiles

Wywołaj GET /social-profiles?brandId=BRAND_ID, aby znaleźć ID podłączonych profili.

4

Resolve optional context

Wywołaj GET /hashtag-libraries?brandId=BRAND_ID, gdy szkic AI ma używać zapisanego kontekstu hashtagów.

5

Create a draft or scheduled post

Wywołaj POST /post?brandId=BRAND_ID z caption, URL-ami mediów, docelowymi ID profili społecznościowych oraz opcjonalnym scheduledAt.

6

Create an AI draft

Wywołaj POST /post/ai?brandId=BRAND_ID z promptem, kiedy chcesz, żeby Ocoya najpierw wygenerowała caption.

7

Create an AI campaign

Wywołaj POST /campaigns?brandId=BRAND_ID, aby zakolejkować generowanie kampanii z wieloma postami i od razu otrzymać odpowiedź GENERATING.

8

Manage posts

Użyj GET /post, PATCH /post/{postId} i DELETE /post/{postId}, aby sprawdzać, zmieniać harmonogram lub usuwać posty.

​
Create A Post

Użyj scheduledAt, gdy chcesz zaplanowany post. Pomiń to pole, jeśli chcesz szkic.

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"
  }'

​
Connect A Social Profile

Użyj POST /social-profiles/connection-url, gdy potrzebujesz URL-a w przeglądarce do podłączenia nowego profilu społecznościowego.

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"}'

Otwórz zwrócony url, będąc zalogowanym w Ocoya.

​
Create An AI Draft

Użyj POST /post/ai, gdy chcesz, żeby Ocoya wygenerowała caption na podstawie promptu, zanim utworzy szkic.

Użyj hashtagLibraryId i referenceDesignIds, kiedy chcesz, żeby szkic korzystał z zapisanej biblioteki hashtagów lub kontekstu szablonów Studio.

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"]
  }'

​
Create An AI Campaign

Użyj POST /campaigns, gdy chcesz, żeby Ocoya w tle wygenerowała kampanię z wieloma postami.

Odpowiedź przychodzi od razu ze statusem GENERATING. Użyj hashtagLibraryId, gdy kampania ma korzystać z zapisanej biblioteki hashtagów.

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 vs REST API

Użyj REST API dla systemów backendowych, które już dokładnie wiedzą, co mają zrobić.

Użyj MCP, kiedy chcesz, żeby klienci AI tacy jak Claude, Codex czy ChatGPT mogli odkrywać i wywoływać narzędzia Ocoya po tym, jak użytkownik zatwierdzi dostęp OAuth.