API ਰੈਫਰੈਂਸ

ਬੇਸ URL

ਹਰ request ਇੱਥੇ ਜਾਂਦੀ ਹੈ:

ਪ੍ਰਮਾਣਿਕਤਾ

API keys ਪੇਜ ਤੇ ਇੱਕ key ਬਣਾਓ, ਫਿਰ ਇਸਨੂੰ Authorization header ਵਿੱਚ bearer token ਵਜੋਂ ਭੇਜੋ। ਤੁਹਾਡੀ key ਦਾ ਸਿਰਫ਼ hash ਸਟੋਰ ਹੁੰਦਾ ਹੈ — ਇਸਨੂੰ ਬਣਦੇ ਹੀ ਕਾਪੀ ਕਰੋ, ਕਿਉਂਕਿ GatifyAI ਇਸਨੂੰ ਮੁੜ ਨਹੀਂ ਦਿਖਾ ਸਕਦਾ।

ਤੁਰੰਤ ਸ਼ੁਰੂਆਤ

curl, Python ਜਾਂ TypeScript ਵਿੱਚ ਇੱਕ ਘੱਟੋ-ਘੱਟ request:

curl https://gatifyai.com/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

ਕਿਸੇ key ਨੂੰ ਖਾਸ models ਤੱਕ ਸੀਮਿਤ ਕਰਨਾ

ਡਿਫਾਲਟ ਤੌਰ ਤੇ ਨਵੀਂ key GatifyAI ਦੇ ਕਿਸੇ ਵੀ ਮੁਫ਼ਤ model ਨੂੰ ਵਰਤ ਸਕਦੀ ਹੈ, ਅਤੇ ਜੇ ਕੋਈ model ਉਪਲਬਧ ਨਾ ਹੋਵੇ ਤਾਂ web chat ਵਾਂਗ ਉਹੀ automatic fallover ਵਰਤਦੀ ਹੈ। ਤੁਸੀਂ ਇਸਦੀ ਬਜਾਏ key ਨੂੰ ਕਿਸੇ ਖਾਸ model ਜਾਂ ਛੋਟੀ list ਤੱਕ ਸੀਮਿਤ ਕਰ ਸਕਦੇ ਹੋ — ਫਿਰ key ਸਿਰਫ਼ ਉਸ list ਦੇ models, ਤੁਹਾਡੇ ਦਿੱਤੇ ਕ੍ਰਮ ਵਿੱਚ, ਵਰਤੇਗੀ, ਭਾਵੇਂ request ਕੋਈ ਵੀ model ਮੰਗੇ। ਉਸ list ਤੋਂ ਬਾਹਰ model ਮੰਗਣ ਤੇ 400 error ਆਉਂਦਾ ਹੈ ਜੋ ਦੱਸਦਾ ਹੈ ਕਿ key ਨੂੰ ਅਸਲ ਵਿੱਚ ਕਿਹੜੇ models ਵਰਤਣ ਦੀ ਇਜਾਜ਼ਤ ਹੈ।

ਪੁਰਸੋਨਾ ਵਜੋਂ ਚੈਟ ਕਰਨਾ

community gallery ਵਿੱਚ ਪ੍ਰਕਾਸ਼ਿਤ ਪੁਰਸੋਨਾ ਵਜੋਂ ਚੈਟ ਕਰਨ ਲਈ model: "persona/<slug>" ਭੇਜੋ — ਇਸਦੀ personality ਅਤੇ preferred models ਆਪਣੇ ਆਪ ਵਰਤੇ ਜਾਂਦੇ ਹਨ, ਫਿਰ ਵੀ ਜੇ ਤੁਸੀਂ key ਲਈ allowed models ਸੈੱਟ ਕੀਤੇ ਹਨ ਤਾਂ ਉਹਨਾਂ ਨਾਲ ਸੀਮਿਤ ਰਹਿੰਦੇ ਹਨ। ਕਿਸੇ ਪੁਰਸੋਨਾ ਦਾ slug ਅਤੇ ਤਿਆਰ example ਉਸਦੇ ਆਪਣੇ page ਤੇ, API tab ਹੇਠਾਂ ਲੱਭੋ।

{
  "model": "persona/senior-engineer",
  "messages": [{"role": "user", "content": "Review my code."}]
}

ਸਟ੍ਰੀਮਿੰਗ ਵਿਰੁੱਧ ਨਾਨ-ਸਟ੍ਰੀਮਿੰਗ

ਟੋਕਨ ਬਣਦੇ ਹੀ ਪ੍ਰਾਪਤ ਕਰਨ ਲਈ stream: true ਸੈੱਟ ਕਰੋ, ਬਿਲਕੁਲ OpenAI streaming format ਵਾਂਗ (Server-Sent Events, [DONE] ਨਾਲ ਖਤਮ)। ਪੂਰਾ ਜਵਾਬ ਉਡੀਕਣ ਅਤੇ ਇੱਕ JSON response ਲੈਣ ਲਈ ਇਸਨੂੰ ਛੱਡ ਦਿਓ ਜਾਂ false ਸੈੱਟ ਕਰੋ — ਇਹੀ ਡਿਫਾਲਟ ਹੈ।

ਗਲਤੀਆਂ

Errors OpenAI error shape ਦੀ ਪਾਲਣਾ ਕਰਦੇ ਹਨ: {"error": {"message": "...", "type": "..."}}। 401 ਦਾ ਅਰਥ ਹੈ missing, invalid ਜਾਂ revoked key। 400 ਦਾ ਅਰਥ ਹੈ request ਆਪਣੇ ਆਪ invalid ਹੈ — ਅਕਸਰ unrecognized model, unpublished/unknown persona slug ਜਾਂ ਤੁਹਾਡੀ key ਦੀ allowed list ਤੋਂ ਬਾਹਰ model। 502 ਦਾ ਅਰਥ ਹੈ ਕਿ ਕਿਸੇ ਵੀ candidate model ਨੇ ਜਵਾਬ ਨਹੀਂ ਦਿੱਤਾ।

{
  "error": {
    "message": "This API key may only use: llama-3.1-8b:free",
    "type": "invalid_request_error"
  }
}

ਰੇਟ limits

API requests web app ਵਾਂਗ ਉਸੇ per-account chat rate limit ਵਿੱਚ ਗਿਣੀਆਂ ਜਾਂਦੀਆਂ ਹਨ — ਅੱਜ API traffic ਲਈ ਕੋਈ ਵੱਖਰਾ quota ਨਹੀਂ ਹੈ।