> ## Documentation Index > Fetch the complete documentation index at: https://starforge.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get Profile ## OpenAPI ````yaml /api-reference/openapi.json get /api/profile openapi: 3.1.0 info: title: StarForge Console description: >- The StarForge control plane. Everything the `sf` CLI and the web console do goes through this API, and so can your own tooling. Authenticate with a bearer token from `POST /api/auth/login` or a CLI device flow; see the Authentication page for how to get one and how long it lasts. version: 0.3.15 servers: - url: https://{host} description: Your StarForge deployment variables: host: default: starforge.your-company.com description: >- The domain your administrator gave you, without a scheme or trailing slash. security: [] tags: - name: auth description: >- Log in, exchange a CLI device code, and inspect the current identity. Everything else on this API needs a bearer token from here. - name: profile description: >- The signed-in user's own account: quota, tokens, preferences, and notification settings. - name: projects description: >- Projects group runs the way `starforge.yaml` names them. A run belongs to exactly one. - name: experiments description: >- Read the experiment definitions the console found in the configured repository. - name: submit description: >- Admit a JobSpec. This is what `sf submit` calls: the catalog handshake, quota check, and preflight all happen here, and a rejection names the gate that refused it. - name: jobs description: >- Everything about a job after it is admitted: status, logs, metrics, samples, artifacts, and the pause/resume/stop controls. - name: runs description: >- Finished work, addressed by run id. A run outlives the job that produced it. - name: ingest description: >- The endpoints training code reports to. `starforge.report` speaks this; you only call it directly when writing an adapter for a framework the catalog does not cover. - name: datasets description: >- Versioned dataset upload, listing, and metadata. Protected datasets expose identity and schema here but never their records. - name: volumes description: Governed directories of files a job may mount read-only. - name: environments description: >- Agent RL environments: their manifests, versions, and upload URLs. A taskset is never returned. - name: benchmarks description: >- The benchmark catalog, the score matrix across runs, and externally scored evaluations. - name: rubrics description: >- Written scoring standards, their revisions, and which runs cited which version. - name: judge description: >- The LLM-judge endpoint a training job calls to score a rollout. OpenAI-compatible. - name: models description: >- The model registry: register a version, promote it, archive it, read its card. - name: model-deployments description: >- Managed model versions serving application traffic: revisions, promotion, rollback, suspension, and deployment tokens. - name: inference description: >- OpenAI-compatible inference against a promoted deployment revision. This is the endpoint applications call. - name: playground description: >- Short-lived serving sessions for human evaluation. Distinct from a deployment: a session expires, a deployment does not. - name: reflow description: >- The governed path from a deployment's production traffic back to the training data of its next version. - name: annotate description: 'Preference annotation: pull a batch, push judgements, read progress.' - name: plugins description: Installed plugins and the extension shelf the console renders. - name: diagnosis description: >- Automated analysis of a finished or failed run, and the accumulated project memory it draws on. - name: approvals description: 'Approval requests: an escalation path, one level deep, with a record.' - name: billing description: >- What the GPU-hours cost. One price on top of the hours the usage page already shows. - name: teams description: 'Teams: the unit capacity is budgeted to. A department, not a tenant.' - name: agent description: >- Submit plans: a proposed submission a human approves or rejects before it becomes a job. - name: share description: >- Public, revocable read-only links to a job or a comparison. The `/api/share/{token}` routes need no bearer token, which is the point. - name: notifications description: The signed-in user's notification feed. - name: search description: Cross-surface search over jobs, runs, datasets, and models. - name: sandbox description: >- Execute model-generated code in a throwaway container with no GPU and no network. - name: uploads description: >- Resumable upload sessions used by dataset, environment, and plugin publishing. - name: integrations-hf description: Hugging Face account linking and repository push. - name: mcp description: Model Context Protocol access information and per-user tool settings. - name: mcp-oauth description: >- OAuth metadata, authorization, token exchange, and dynamic client registration for MCP clients. - name: cluster description: Live capacity and node state across the fleets. - name: fleets description: >- Registered execution backends and the machines in them. Reading is open to every user; creating a fleet, minting a join token and draining a node are admin-only. Joining is authorized by the join token alone. - name: admin description: >- User, role, quota, hardware, schedule, integration, and settings administration. Admin role required. - name: tasks description: >- Scheduled platform maintenance tasks: what they are, when they last ran, and running one now. - name: report description: The rendered daily report page. - name: health description: Liveness and version. Unauthenticated. paths: /api/profile: get: tags: - profile summary: Get Profile operationId: get_profile_api_profile_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProfileOut' security: - HTTPBearer: [] components: schemas: ProfileOut: properties: user: $ref: '#/components/schemas/ProfileUserOut' quota: $ref: '#/components/schemas/QuotaOut' usage: $ref: '#/components/schemas/UsageRowOut' type: object required: - user - quota - usage title: ProfileOut ProfileUserOut: properties: id: type: integer title: Id username: type: string title: Username display_name: anyOf: - type: string - type: 'null' title: Display Name email: anyOf: - type: string - type: 'null' title: Email avatar: anyOf: - type: string - type: 'null' title: Avatar role: type: string title: Role auth_source: type: string title: Auth Source disabled: type: boolean title: Disabled created_at: anyOf: - type: string - type: 'null' title: Created At has_password: type: boolean title: Has Password default: false type: object required: - id - username - role - auth_source - disabled title: ProfileUserOut QuotaOut: properties: max_concurrent_gpus: anyOf: - type: integer - type: 'null' title: Max Concurrent Gpus max_concurrent_jobs: anyOf: - type: integer - type: 'null' title: Max Concurrent Jobs daily_gpu_hours: type: integer title: Daily Gpu Hours default: 0 max_storage_gb: type: integer title: Max Storage Gb default: 0 allowed_profiles: items: type: string type: array title: Allowed Profiles default: [] priority: type: integer title: Priority default: 0 per_series: additionalProperties: additionalProperties: type: integer type: object type: object title: Per Series default: {} default: type: boolean title: Default default: false type: object title: QuotaOut UsageRowOut: properties: username: type: string title: Username user_display_name: anyOf: - type: string - type: 'null' title: User Display Name active_gpus: type: integer title: Active Gpus default: 0 active_jobs: type: integer title: Active Jobs default: 0 gpu_hours_total: type: number title: Gpu Hours Total default: 0 gpu_hours_today: type: number title: Gpu Hours Today default: 0 running: items: $ref: '#/components/schemas/UsageRunningJobOut' type: array title: Running default: [] active_gpus_by_series: additionalProperties: type: integer type: object title: Active Gpus By Series default: {} gpu_hours_today_by_series: additionalProperties: type: number type: object title: Gpu Hours Today By Series default: {} storage_bytes: type: integer title: Storage Bytes default: 0 storage_measured_at: type: number title: Storage Measured At default: 0 type: object required: - username title: UsageRowOut UsageRunningJobOut: properties: run_id: type: string title: Run Id job_ref: anyOf: - type: string - type: 'null' title: Job Ref exp: type: string title: Exp default: '' project_key: type: string title: Project Key default: '' project: type: string title: Project default: '' project_display_name: type: string title: Project Display Name default: '' name: type: string title: Name default: '' profile: anyOf: - type: string - type: 'null' title: Profile gpus: anyOf: - type: integer - type: 'null' title: Gpus status: type: string title: Status default: '' type: object required: - run_id title: UsageRunningJobOut securitySchemes: HTTPBearer: type: http scheme: bearer ````