> ## Documentation Index
> Fetch the complete documentation index at: https://docs.jeanmemory.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get schema

> Inspect the active extraction schema for a domain.

Read-only. Returns the field definitions the platform uses when extracting from `context` or `POST /context`. Useful for:

* Debugging why a field isn't being extracted.
* Documenting your own integration against the canonical shape.
* Building admin UIs that show users what they're consenting to.

Schema changes are made through onboarding sessions, not this API.

<CodeGroup>
  ```bash curl theme={"dark"}
  curl "https://api.jeantechnologies.com/v1/schema?domain=dating" \
    -H "Authorization: Bearer $JEAN_API_KEY"
  ```

  ```python Python theme={"dark"}
  schema = requests.get(
      "https://api.jeantechnologies.com/v1/schema",
      headers={"Authorization": f"Bearer {os.environ['JEAN_API_KEY']}"},
      params={"domain": "dating"},
  ).json()
  ```

  ```ts TypeScript theme={"dark"}
  const res = await fetch(
    "https://api.jeantechnologies.com/v1/schema?domain=dating",
    { headers: { Authorization: `Bearer ${process.env.JEAN_API_KEY}` } },
  );
  const schema = await res.json();
  ```
</CodeGroup>

## Example response

```json theme={"dark"}
{
  "domain": "dating",
  "version": "dating.v3",
  "fields": [
    { "name": "age",               "kind": "hard",    "type": "integer", "required": true,  "priority": "high"   },
    { "name": "gender",            "kind": "hard",    "type": "enum",    "required": true,  "priority": "high"   },
    { "name": "location",          "kind": "hard",    "type": "string",  "required": true,  "priority": "high"   },
    { "name": "relationship_goal", "kind": "hard",    "type": "enum",    "required": false, "priority": "medium" },
    { "name": "values_text",       "kind": "soft",    "type": "string",  "required": false, "priority": "medium" },
    { "name": "attachment_style",  "kind": "derived", "type": "enum",    "required": false, "priority": "low"    }
  ]
}
```

Three field kinds:

| Kind      | Used by            | Example            |
| --------- | ------------------ | ------------------ |
| `hard`    | SQL filter stage   | `age`, `location`  |
| `soft`    | embedding stage    | `values_text`      |
| `derived` | computed at ingest | `attachment_style` |

See [Concepts](/concepts) for what each kind means in practice.


## OpenAPI

````yaml GET /schema
openapi: 3.1.0
info:
  title: Jean Technologies API
  version: 1.0.0
  description: >-
    Matching infrastructure for AI-era platforms. Ingest user context, retrieve
    compatible candidates, send outcomes back.
servers:
  - url: https://api.jeantechnologies.com/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /schema:
    get:
      tags:
        - Schema
      summary: Get schema
      description: Return the active extraction schema for a domain.
      operationId: getSchema
      parameters:
        - name: domain
          in: query
          required: true
          schema:
            type: string
            example: dating
      responses:
        '200':
          description: Schema
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Schema'
components:
  schemas:
    Schema:
      type: object
      properties:
        domain:
          type: string
          example: dating
        version:
          type: string
          example: dating.v3
        fields:
          type: array
          items:
            $ref: '#/components/schemas/SchemaField'
    SchemaField:
      type: object
      properties:
        name:
          type: string
          example: age
        kind:
          type: string
          enum:
            - hard
            - soft
            - derived
          example: hard
        type:
          type: string
          example: integer
        required:
          type: boolean
          example: true
        priority:
          type: string
          enum:
            - high
            - medium
            - low
          example: high
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key issued by Jean Technologies. Contact the team for access.

````