Skip to content
Everruns Everruns

Get a specific model with provider info and profile

GET
/v1/models/{id}
 
curl --request GET \
  --url https://app.everruns.com/api/v1/models/example

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Model ID (prefixed, e.g., mod_…)

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Model found

Media type application/json

Wrapper that adds API and UI links to a serialized resource.

Uses self_url (not url) for the API link to avoid collision with resources that already have a url field (e.g. McpServer). The allowed_actions array carries state-aware hypermedia links — empty (and omitted from the wire shape) until the underlying resource opts into the convention by overriding ResourceUrlable::allowed_actions.

object
capabilities
required

Capability tags supported by this model.

Array<string>
created_at
required

Timestamp when this model was created (RFC 3339).

string format: date-time
display_name
required

Human-readable display name.

string
enabled
required

Whether this model is selectable. Controls UI visibility AND server-side resolution: ProviderResolverService requires enabled = true, and org default-model validation rejects disabled models.

boolean
healthy
required

Derived: model is configured and ready for use. Currently means the joined provider is active and has an API key set; over time this may also incorporate live reachability checks. Not persisted.

boolean
id
required

Prefixed public identifier. See ID Schema.

string
is_favorite
required

Whether this model is starred in the UI for quick access.

boolean
model_id
required

Provider-side model identifier as sent on the wire (e.g. gpt-4o).

string
model_vendor
One of:
null
profile
One of:
null
provider_id
required

Owning provider’s prefixed public identifier.

string
provider_name
required

Joined provider display name.

string
provider_type
required

Joined provider implementation type.

string
source
required

How this model entry was added (manually, discovered, or seeded as predefined).

string
Allowed values: manual discovered predefined
updated_at
required

Timestamp when this model was last updated (RFC 3339).

string format: date-time
allowed_actions

State-aware hypermedia actions the caller can take on this resource next (e.g. cancel, events, update). Omitted from the wire shape when empty so resources that haven’t opted into the convention don’t grow their payloads.

Array<object>

Agent-actionable link describing a follow-up the caller can take. Used in two contexts:

  • Error recovery — ErrorResponse.allowed_actions carries rels like retry, retry-later, unarchive, get-existing so the agent knows the right next call after a 4xx/429.
  • Entity hypermedia — WithUrls<T>.allowed_actions carries state-aware rels like cancel, events, self, update on the entity itself so the agent can follow links instead of reconstructing routes from prose.

The shape is intentionally identical across both contexts; the closed rel vocabulary documented in specs/api-conventions.md distinguishes them.

object
hint

Short, agent-readable hint (e.g. “Shorten ‘name’ to <= 200 chars.”, “Cancel the active turn for this session.”).

string | null
href

Absolute (preferred) or relative URL the caller may invoke directly. Always present on entity hypermedia actions (WithUrls<T>.allowed_actions); optional on error-recovery actions (ErrorResponse.allowed_actions) where the matching operation_id is enough and the URI is implicit from the failed call.

string | null
method

HTTP method to use against href. Required for entity hypermedia actions; usually omitted on error-recovery actions where the same operation is retried with its original method.

string | null
operation_id

OpenAPI operationId the caller should invoke. Lets an MCP client resolve the call without parsing href.

string | null
rel
required

Link relation describing the action. Closed vocabulary documented in specs/api-conventions.md — examples: self, cancel, pause, resume, events, retry, retry-later, unarchive, get-existing, delete, update.

string
schema_ref

OpenAPI $ref to the request-body schema, when the action takes one (e.g. #/components/schemas/UpdateSessionRequest). Lets a tool-calling agent fetch the input shape without scanning the whole spec.

string | null
self_url
required

Full API endpoint URL for this resource.

string
ui_link
required

Alias for view_url, used by command and MCP outputs.

string
view_url
required

Full UI URL for viewing this resource.

string
Example 
{
  "capabilities": [
    "text",
    "tools",
    "vision",
    "thinking"
  ],
  "created_at": "2026-01-04T11:23:00Z",
  "display_name": "Claude Sonnet 4.5",
  "enabled": true,
  "healthy": true,
  "id": "model_01933b5a00007000800000000000001",
  "is_favorite": true,
  "model_id": "claude-sonnet-4-5",
  "model_vendor": "openai",
  "profile": {
    "modalities": {
      "input": [
        "text"
      ],
      "output": [
        "text"
      ]
    },
    "reasoning_effort": {
      "default": "none",
      "values": [
        {
          "value": "none"
        }
      ]
    }
  },
  "provider_id": "provider_01933b5a00007000800000000000001",
  "provider_name": "Anthropic",
  "source": "manual",
  "updated_at": "2026-05-27T15:24:00Z",
  "allowed_actions": [
    {
      "method": "POST"
    }
  ]
}

400

Section titled “400 ”

Invalid model ID

404

Section titled “404 ”

Model not found