---
title: "GET /editor-agent/preferences"
method: GET
path: "/editor-agent/preferences"
tags: ["Editor Agent"]
---

# GET /editor-agent/preferences

`GET /editor-agent/preferences`

## Request

- Base URL: `https://app.openpo.st/api/v1`
- URL: `https://app.openpo.st/api/v1/editor-agent/preferences`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `openpost_session`

## Query parameters

- `workspace_id` string, required
- `project_id` string
- `editor_kind` 'video' | 'image'
- `context` string

## Response `200`

OK

- Context
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `favorites` Favorite[], nullable, required
    - `device_local` boolean, required
    - `editor_kind` string, required
    - `entry_id` string, required
    - `entry_name` string, required
    - `favorite` boolean, required
    - `updated_at` string, date-time
  - `learning_enabled` boolean, required
  - `preferences` Preference[], nullable, required
    - `$schema` string, uri: A URL to the JSON Schema for this object.
    - `context` string, required
    - `editor_kind` 'video' | 'image' | 'both', required
    - `enabled` boolean, required
    - `id` string
    - `project_id` string, required
    - `revision` integer
    - `rule` string, required
    - `source_instruction` string, required
    - `updated_at` string, date-time
    - `workspace_id` string
  - `styles` Style[], nullable, required
    - `$schema` string, uri: A URL to the JSON Schema for this object.
    - `archived` boolean
    - `built_in` boolean
    - `context` string, required
    - `created_at` string, date-time
    - `definition` StyleDefinition, required
      - `captions` TextStyle, required
        - `align` 'left' | 'center' | 'right' | ''
        - `color` string
        - `font_asset_id` string
        - `font_family` string
        - `font_size` number, double
      - `guidance` string[], required
      - `interpretations` string[], required
      - `library` LibraryReference[], required
        - `id` string
        - `role` string, required
        - `version` string
      - `palette` string[], required
      - `source_project_id` string
      - `source_revision` string
      - `typography` TextStyle, required
        - `align` 'left' | 'center' | 'right' | ''
        - `color` string
        - `font_asset_id` string
        - `font_family` string
        - `font_size` number, double
    - `editor_kind` 'video' | 'image' | 'both', required
    - `id` string
    - `name` string, required
    - `shared` boolean
    - `source_instruction` string, required
    - `version` integer
    - `workspace_id` string
  - `suggestions` Suggestion[], nullable, required
    - `context` string, required
    - `entry_id` string, required
    - `entry_name` string, required
    - `last_used_at` string, date-time, required
    - `projects` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/openpo/apis/openpost-api.md) · [All operations](https://skmtc.dev/openpo/apis/openpost-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openpo/apis/openpost-api/revisions/67d3964458a7?raw)