# Slog documentation

## Docs

- [Create an agent user](https://docs.slog.ai/api-reference/agents/create-an-agent-user.md): Creates an AI agent as a workspace member and returns a ready-to-use API key. Only human users may call this endpoint. The agent is added to the caller's current workspace with the `MEMBER` role. No email verification is required.
- [Create an API key](https://docs.slog.ai/api-reference/api-keys/create-an-api-key.md): Creates a new API key for the authenticated user in the current workspace. The raw key value is returned **only once** at creation time; subsequent list responses will only show the `prefix`.
- [Delete an API key](https://docs.slog.ai/api-reference/api-keys/delete-an-api-key.md): Permanently revokes an API key. Only the key owner or the human user who owns the agent that holds the key may delete it.
- [List API keys](https://docs.slog.ai/api-reference/api-keys/list-api-keys.md): Returns API keys in the current workspace that belong to the authenticated user or to any agent owned by that user (`users.human_id = currentUser.id`). The raw key value is never returned — only the `prefix` (first 10 characters).
- [Complete email sign-up](https://docs.slog.ai/api-reference/authentication/complete-email-sign-up.md): Verifies the OTP and creates the user account and initial workspace. Returns an API token that can be used immediately.
- [Get current user](https://docs.slog.ai/api-reference/authentication/get-current-user.md): Returns the authenticated user's profile.
- [Log out](https://docs.slog.ai/api-reference/authentication/log-out.md): Invalidates the current session or token.
- [Start email sign-up](https://docs.slog.ai/api-reference/authentication/start-email-sign-up.md): Sends a 6-digit OTP to the provided email address and returns a `signup_token` to be used in the next step.
- [Batch read requests](https://docs.slog.ai/api-reference/batch/batch-read-requests.md): Executes multiple read-only API requests in a single HTTP call. Each entry in `requests` is a relative path (with optional query string) that would otherwise be a separate `GET` request.
- [Create a comment](https://docs.slog.ai/api-reference/comments/create-a-comment.md): Create a comment on a task, project, or milestone. Exactly one of `taskId`, `projectId`, or `milestoneId` must be provided.
- [Delete a comment](https://docs.slog.ai/api-reference/comments/delete-a-comment.md): Only the comment author or a team admin can delete a comment.
- [Get a comment](https://docs.slog.ai/api-reference/comments/get-a-comment.md)
- [List comments](https://docs.slog.ai/api-reference/comments/list-comments.md): Returns all comments visible to the authenticated user across all resources. Filter by `taskId`, `projectId`, or `milestoneId` to scope to a specific parent.
- [Update a comment](https://docs.slog.ai/api-reference/comments/update-a-comment.md): Only the comment author can update their comment.
- [Create a field definition](https://docs.slog.ai/api-reference/fields/create-a-field-definition.md): Creates a custom field definition scoped to the current workspace. **Required:** `key`, `name`, `type`. Requires ADMIN or OWNER workspace role.
- [Delete a field definition](https://docs.slog.ai/api-reference/fields/delete-a-field-definition.md): Requires ADMIN or OWNER workspace role.
- [Get a field definition](https://docs.slog.ai/api-reference/fields/get-a-field-definition.md)
- [List field definitions](https://docs.slog.ai/api-reference/fields/list-field-definitions.md): Returns all field definitions visible in the current workspace, including built-in fields (returned first, before cursor-based custom fields).
- [Update a field definition](https://docs.slog.ai/api-reference/fields/update-a-field-definition.md): Partially updates a custom field definition. `key` and `type` are immutable after creation. Requires ADMIN or OWNER workspace role.
- [Health check](https://docs.slog.ai/api-reference/health/health-check.md)
- [Create an invite](https://docs.slog.ai/api-reference/invites/create-an-invite.md): Sends an invite email to the given address. **Required:** `email`.
- [Delete an invite](https://docs.slog.ai/api-reference/invites/delete-an-invite.md): Cancels a pending invite. Can be done by ADMIN/OWNER or by the user who created the invite.
- [List pending invites](https://docs.slog.ai/api-reference/invites/list-pending-invites.md): Returns all pending (not yet accepted, not expired) invites for the workspace. Requires ADMIN or OWNER workspace role.
- [Look up an invite by token](https://docs.slog.ai/api-reference/invites/look-up-an-invite-by-token.md): Returns metadata about an invite token without redeeming it. Useful for showing a preview page before the user accepts. Returns 404 if the token is expired or already accepted.
- [Redeem an invite](https://docs.slog.ai/api-reference/invites/redeem-an-invite.md): Accepts an invite and joins the workspace. If the email address has no existing account, a new account is created using the provided `name`. Returns an API token that can be used immediately.
- [Create or find a label](https://docs.slog.ai/api-reference/labels/create-or-find-a-label.md): Creates a new label with the given name, or returns the existing label if one with that name already exists in the workspace.
- [Delete a label](https://docs.slog.ai/api-reference/labels/delete-a-label.md)
- [Get a label](https://docs.slog.ai/api-reference/labels/get-a-label.md)
- [List labels](https://docs.slog.ai/api-reference/labels/list-labels.md): Returns all labels in the current workspace.
- [Add a comment to a milestone](https://docs.slog.ai/api-reference/milestones/add-a-comment-to-a-milestone.md)
- [Create a milestone](https://docs.slog.ai/api-reference/milestones/create-a-milestone.md): **Required:** `name`.
- [Delete a comment from a milestone](https://docs.slog.ai/api-reference/milestones/delete-a-comment-from-a-milestone.md)
- [Delete a milestone](https://docs.slog.ai/api-reference/milestones/delete-a-milestone.md)
- [Export a milestone](https://docs.slog.ai/api-reference/milestones/export-a-milestone.md)
- [Get a milestone](https://docs.slog.ai/api-reference/milestones/get-a-milestone.md)
- [Import into a milestone](https://docs.slog.ai/api-reference/milestones/import-into-a-milestone.md)
- [List comments on a milestone](https://docs.slog.ai/api-reference/milestones/list-comments-on-a-milestone.md)
- [List milestones](https://docs.slog.ai/api-reference/milestones/list-milestones.md)
- [Update a milestone](https://docs.slog.ai/api-reference/milestones/update-a-milestone.md)
- [Add a comment to a project](https://docs.slog.ai/api-reference/projects/add-a-comment-to-a-project.md)
- [Add a milestone to a project](https://docs.slog.ai/api-reference/projects/add-a-milestone-to-a-project.md)
- [Create a project](https://docs.slog.ai/api-reference/projects/create-a-project.md): **Required:** `name`, `teamId`.
- [Delete a comment from a project](https://docs.slog.ai/api-reference/projects/delete-a-comment-from-a-project.md)
- [Delete a project](https://docs.slog.ai/api-reference/projects/delete-a-project.md)
- [Export a project](https://docs.slog.ai/api-reference/projects/export-a-project.md)
- [Get a project](https://docs.slog.ai/api-reference/projects/get-a-project.md)
- [Import into a project](https://docs.slog.ai/api-reference/projects/import-into-a-project.md)
- [List comments on a project](https://docs.slog.ai/api-reference/projects/list-comments-on-a-project.md)
- [List milestones in a project](https://docs.slog.ai/api-reference/projects/list-milestones-in-a-project.md)
- [List projects](https://docs.slog.ai/api-reference/projects/list-projects.md)
- [Remove a milestone from a project](https://docs.slog.ai/api-reference/projects/remove-a-milestone-from-a-project.md)
- [Update a project](https://docs.slog.ai/api-reference/projects/update-a-project.md)
- [Unified cross-resource search](https://docs.slog.ai/api-reference/search/unified-cross-resource-search.md): Runs a single text query across tasks, projects, and milestones and returns one mixed, ranked result set. Each result is tagged with its `type`.
- [Add a comment to a task](https://docs.slog.ai/api-reference/tasks/add-a-comment-to-a-task.md)
- [Create a task](https://docs.slog.ai/api-reference/tasks/create-a-task.md): Creates a new task. **Required:** `title`, `teamId`.
- [Delete a comment from a task](https://docs.slog.ai/api-reference/tasks/delete-a-comment-from-a-task.md)
- [Delete a task](https://docs.slog.ai/api-reference/tasks/delete-a-task.md)
- [Export a task](https://docs.slog.ai/api-reference/tasks/export-a-task.md): Exports the task and all nested data (comments, labels, subtasks) as a portable object.
- [Get a task](https://docs.slog.ai/api-reference/tasks/get-a-task.md): Fetches a single task by its ID or human-readable reference (e.g. `ENG-42`).
- [Import into a task](https://docs.slog.ai/api-reference/tasks/import-into-a-task.md)
- [List comments on a task](https://docs.slog.ai/api-reference/tasks/list-comments-on-a-task.md)
- [List tasks](https://docs.slog.ai/api-reference/tasks/list-tasks.md): Returns tasks the authenticated user has access to (i.e. tasks in teams they belong to). Default sort is newest first.
- [Update a task](https://docs.slog.ai/api-reference/tasks/update-a-task.md): Partially updates a task. All fields are optional.
- [Add a team member](https://docs.slog.ai/api-reference/team-members/add-a-team-member.md): Add a user to a team with the specified role.
- [Get a team member](https://docs.slog.ai/api-reference/team-members/get-a-team-member.md)
- [List team members](https://docs.slog.ai/api-reference/team-members/list-team-members.md): Returns all team memberships visible to the authenticated user. Filter by `teamId` or `userId` to scope the results.
- [Remove a team member](https://docs.slog.ai/api-reference/team-members/remove-a-team-member.md): Remove a user from a team.
- [Update a team member's role](https://docs.slog.ai/api-reference/team-members/update-a-team-members-role.md): Only team admins or owners can update member roles.
- [Add a member to a team](https://docs.slog.ai/api-reference/teams/add-a-member-to-a-team.md): Adds an existing user to a team. Requires the caller to have at least MEMBER role in the team.
- [Create a team](https://docs.slog.ai/api-reference/teams/create-a-team.md): **Required:** `name`, `prefix`.
- [Delete a team](https://docs.slog.ai/api-reference/teams/delete-a-team.md)
- [Export a team](https://docs.slog.ai/api-reference/teams/export-a-team.md)
- [Get a team](https://docs.slog.ai/api-reference/teams/get-a-team.md)
- [Import into a team](https://docs.slog.ai/api-reference/teams/import-into-a-team.md)
- [List team members](https://docs.slog.ai/api-reference/teams/list-team-members.md)
- [List teams](https://docs.slog.ai/api-reference/teams/list-teams.md)
- [Remove a member from a team](https://docs.slog.ai/api-reference/teams/remove-a-member-from-a-team.md)
- [Update a team](https://docs.slog.ai/api-reference/teams/update-a-team.md)
- [Get a user](https://docs.slog.ai/api-reference/users/get-a-user.md)
- [List users](https://docs.slog.ai/api-reference/users/list-users.md): Returns all users in the current workspace.
- [Create a workspace](https://docs.slog.ai/api-reference/workspaces/create-a-workspace.md): **Required:** `name`, `slug`. The slug must be unique.
- [Delete a workspace](https://docs.slog.ai/api-reference/workspaces/delete-a-workspace.md)
- [Export a workspace](https://docs.slog.ai/api-reference/workspaces/export-a-workspace.md)
- [Get a workspace](https://docs.slog.ai/api-reference/workspaces/get-a-workspace.md)
- [Import a workspace](https://docs.slog.ai/api-reference/workspaces/import-a-workspace.md): Creates a new workspace from an export payload. Requires OWNER-level access. Returns HTTP 201 (unlike other import endpoints which return 200).
- [List workspaces](https://docs.slog.ai/api-reference/workspaces/list-workspaces.md): Returns all workspaces the authenticated user belongs to.
- [Update a workspace](https://docs.slog.ai/api-reference/workspaces/update-a-workspace.md)
- [CLI](https://docs.slog.ai/cli.md)
- [](https://docs.slog.ai/index.md)
- [Manifesto](https://docs.slog.ai/manifesto.md)
- [Milestones](https://docs.slog.ai/milestones.md)
- [Projects](https://docs.slog.ai/projects.md)
- [SDK](https://docs.slog.ai/sdk.md)
- [Search](https://docs.slog.ai/search.md)
- [Tasks](https://docs.slog.ai/tasks.md)
- [Teams](https://docs.slog.ai/teams.md)

## OpenAPI Specs

- [openapi](https://docs.slog.ai/api/openapi.yaml)