Refabric Docs

For AI agents: this page is also available as Markdown at https://docs.refabric.com/api-reference/platform/reference-data/read-a-concept.md, and the index of every page is https://docs.refabric.com/llms.txt.

Platform API › Reference data

Read a concept

One concept by name.

GEThttps://api.refabric.com/v1/concepts/{name}
import requests

url = "https://api.refabric.com/v1/concepts/{name}"

response = requests.get(url)

print(response.json())
{
  "name": "moodboard",
  "short": "A set of images.",
  "long": "A moodboard collects …",
  "related": [
    "brand_kit"
  ],
  "produced_by": [
    "moodboard.create"
  ],
  "used_by": [
    "image.generate"
  ]
}

Authentication. No key: the reference is the same for every reader and shows nothing of an account.

Common use cases

  • Show what a word in a task's schema means.

Conflicts. An unknown name answers 404.

See also

  • GET /v1/concepts

Authorization

No key needed.

Parameters

Path parameters

  • stringrequired

Header parameters

  • stringoptional

    The contract version you wrote against (a date). Absent: the current version.

    format: date

  • stringoptional

    Your own id for this request; we answer it back under X-Client-Request-ID.

    max length 128

Response

200 — Done: the answer is in the body.

  • stringrequired

    The concept's name.

    Example: moodboard

  • stringrequired

    What it is, in one line.

    Example: A set of images.

  • stringrequired

    What it is, in full.

    Example: A moodboard collects …

  • array<string>required

    The tasks that make it.

    Example: ["moodboard.create"]

  • array<string>required

    The tasks that take it as an input.

    Example: ["image.generate"]

  • 401 — No valid API key was sent.
  • 403 — Your key or your plan does not allow this.
  • 404 — Nothing has this address.
  • 429 — Too many requests: wait for the number of seconds in the Retry-After header.
  • 500 — Something went wrong on our side; retry, and quote the request id if it keeps happening.