Get Schema

Retrieve a specific schema by its ID

GET /schemas/{id}

curl --request GET \
  --url https://api.flora.withflora.ai/schemas/00f9190e-9a4a-4e08-ba00-f888437ed3c4 \
  --header 'Authorization: Bearer <your_token>'

{
  "status": true,
  "message": "Schema retrieved successfully",
  "data": {
    "id": "00f9190e-9a4a-4e08-ba00-f888437ed3c4",
    "name": "News Articles",
    "structure": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "describe": "The article title"
          },
          "summary": {
            "type": "string",
            "describe": "The news summary"
          },
          "link": {
            "type": "string",
            "describe": "URL to learn more"
          }
        }
      }
    },
    "createdAt": "2025-03-20T15:37:16.163+00:00"
  }
}

This endpoint retrieves a specific schema using its unique identifier.

Path Parameters

id · string · required

The unique identifier of the schema to retrieve

Response

status · boolean

Indicates if the request was successful

message · string

A message describing the result of the operation

data · object

The schema details

Show Schema Object

id · string

Unique identifier for the schema

name · string

Name of the schema

structure · object

The JSON structure defining the schema format

createdAt · string

Timestamp when the schema was created

curl --request GET \
  --url https://api.flora.withflora.ai/schemas/00f9190e-9a4a-4e08-ba00-f888437ed3c4 \
  --header 'Authorization: Bearer <your_token>'

{
  "status": true,
  "message": "Schema retrieved successfully",
  "data": {
    "id": "00f9190e-9a4a-4e08-ba00-f888437ed3c4",
    "name": "News Articles",
    "structure": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "describe": "The article title"
          },
          "summary": {
            "type": "string",
            "describe": "The news summary"
          },
          "link": {
            "type": "string",
            "describe": "URL to learn more"
          }
        }
      }
    },
    "createdAt": "2025-03-20T15:37:16.163+00:00"
  }
}