Generate knowledge

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/knowledge/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "candidateKnowledge": "Customers on annual plans can cancel at the end of the current billing term.",
    "origin": "generated",
    "botId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "isDraft": true
  }'

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/knowledge/public",
    headers={
        "Authorization": "Bearer fini_your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "candidateKnowledge": "Customers on annual plans can cancel at the end of the current billing term.",
        "origin": "generated",
        "botId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
        "isDraft": True,
    },
)
job = response.json()

const response = await fetch("https://api-prod.usefini.com/v2/knowledge/public", {
  method: "POST",
  headers: {
    Authorization: "Bearer fini_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    candidateKnowledge:
      "Customers on annual plans can cancel at the end of the current billing term.",
    origin: "generated",
    botId: "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    isDraft: true,
  }),
});
const job = await response.json();

{
  "backgroundJobId": "4cfcf2cc-7a06-4de2-b460-5b991fe6236a"
}

POST

knowledge

public

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/knowledge/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "candidateKnowledge": "Customers on annual plans can cancel at the end of the current billing term.",
    "origin": "generated",
    "botId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "isDraft": true
  }'

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/knowledge/public",
    headers={
        "Authorization": "Bearer fini_your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "candidateKnowledge": "Customers on annual plans can cancel at the end of the current billing term.",
        "origin": "generated",
        "botId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
        "isDraft": True,
    },
)
job = response.json()

const response = await fetch("https://api-prod.usefini.com/v2/knowledge/public", {
  method: "POST",
  headers: {
    Authorization: "Bearer fini_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    candidateKnowledge:
      "Customers on annual plans can cancel at the end of the current billing term.",
    origin: "generated",
    botId: "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    isDraft: true,
  }),
});
const job = await response.json();

{
  "backgroundJobId": "4cfcf2cc-7a06-4de2-b460-5b991fe6236a"
}

Use this route when you already have the candidate content you want to turn into knowledge and need Fini to process it as a single background job.

This route always requires candidateKnowledge. If you want Fini to generate directly from stored source content, use Bulk generate knowledge instead. isDraft defaults to true.

Origins

Origin	Use it for	Extra required field
`generated`	Raw candidate text that is not tied to another Fini record	None
`sources`	Candidate text you want to associate with one ingested source record	`documentId`
`inbox`	Candidate text you want to associate with one inbox event	`hcEventId`

Headers

string

required

Bearer token containing your Fini workspace API key. Format: Bearer fini_... The key needs write scope.

string

required

application/json

Body parameters

string

required

Candidate content to turn into knowledge.

string

required

Origin for the content. Allowed values are sources, generated, and inbox.

string

Required when origin is sources. This is the ingested source ID you want to link the generated result to.

string

Required when origin is inbox. This is the inbox event ID you want to link the generated result to.

array

Optional operation restrictions passed through to the generation pipeline. Use this to limit what Fini is allowed to do when it decides how to apply the generated knowledge.

string

Additional generation instructions.

string

Optional agent ID to scope the generated content to.

boolean

default:true

Whether the generated result should remain a draft.

`restrictedOps` values

Use restrictedOps to limit the operation choices available to the knowledge-generation pipeline for that request.

Value	Meaning
`ADD_ARTICLE_TO_FOLDER`	Allow Fini to create a new article in an existing folder.
`UPDATE_ARTICLE`	Allow Fini to update an existing article that the pipeline selects as the best match.
`DO_NOTHING`	Allow Fini to decide that no knowledge change should be applied. When `isDraft` is `true`, this still creates a reviewable draft/no-op record.

curl --request POST \
  --url 'https://api-prod.usefini.com/v2/knowledge/public' \
  --header 'Authorization: Bearer fini_your_api_key' \
  --header 'Content-Type: application/json' \
  --data '{
    "candidateKnowledge": "Customers on annual plans can cancel at the end of the current billing term.",
    "origin": "generated",
    "botId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "isDraft": true
  }'

import requests

response = requests.post(
    "https://api-prod.usefini.com/v2/knowledge/public",
    headers={
        "Authorization": "Bearer fini_your_api_key",
        "Content-Type": "application/json",
    },
    json={
        "candidateKnowledge": "Customers on annual plans can cancel at the end of the current billing term.",
        "origin": "generated",
        "botId": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
        "isDraft": True,
    },
)
job = response.json()

const response = await fetch("https://api-prod.usefini.com/v2/knowledge/public", {
  method: "POST",
  headers: {
    Authorization: "Bearer fini_your_api_key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    candidateKnowledge:
      "Customers on annual plans can cancel at the end of the current billing term.",
    origin: "generated",
    botId: "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    isDraft: true,
  }),
});
const job = await response.json();

Response

string

Background job ID for the queued generation request.

{
  "backgroundJobId": "4cfcf2cc-7a06-4de2-b460-5b991fe6236a"
}

Next step

Poll the queued job with Check knowledge jobs. If you left isDraft at its default true, review or publish the resulting draft before expecting live agent answers to change.

Errors

400 Bad Request

The request body is malformed, candidateKnowledge is missing, origin is invalid, or the origin-specific required field is missing.

401 Unauthorized

The API key is missing, malformed, revoked, or invalid.

403 Forbidden

The API key does not include the write scope.

Generation completed but nothing changed live

Expected when isDraft was left at its default true. Poll the job status, then review or publish the resulting draft through the article workflow.

500 Internal Server Error

Fini failed while queueing or processing the generation job. Retry once, then inspect the job with Check knowledge jobs.

⌘I

​Origins

​Headers

​Body parameters

​restrictedOps values

​Response

​Next step

​Errors

Origins

Headers

Body parameters

`restrictedOps` values

Response

Next step

Errors