Projects

Manage projects, URLs, settings, and project resources.

GET

Get one project from its URL slug, same object as the by-ID lookup

/organizations/{organizationId}/projects/by-slug/{projectSlug}

Retrieves the full details of a single project by its URL-friendly slug within the specified organization. This is an alternative to looking up a project by its UUID when you have the human-readable slug from a URL or user input. Returns the same complete project object as the get-by-ID endpoint including name, slug, description, settings, and timestamps.

Parameters

organizationIdRequired

path · stringOrganization ID

projectSlugRequired

path · stringProject slug

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const org = await gc.organizations.getOrganizationBySlug({ organizationSlug: "my-org" });6
7const project = await gc.projects.getProjectBySlug({8  organizationId: org.id,9  projectSlug: "my-project",10});11

GET

Search project material by meaning, not literal text; returns ranked cited excerpts

/organizations/{organizationId}/projects/{projectId}/search

Semantic search across all project knowledge — files, pages, posts, KB articles, developer docs, SDK methods, emails, and private CRM data. Returns the most relevant text chunks ranked by similarity, with sourceType and sourceId citations. Use the sourceId with the appropriate get endpoint (getFile, getWebsitePage, etc.) to retrieve the full source document.

Parameters

page

query · numberPage number to return, 1-indexed. Defaults to 1.

pageSize

query · numberItems per page (1-100). Defaults to 10.

lite

query · stringWhen 'true', return only essential fields (id, slug, title/name) to reduce payload size. Useful for context fetching and link resolution.

sort

query · stringSort specifier as 'field:direction'. Sortable fields: similarity, sourceType. Direction is 'asc' or 'desc' and defaults to 'asc'.

query · stringFree-text search. Matched against: content.

sourceType

query · stringFilter by sourceType. Operators: sourceType=value (equals), sourceType_ne, sourceType_gt, sourceType_gte, sourceType_lt, sourceType_lte, sourceType_like (contains), sourceType_isnull=true|false, sourceType_has=value (jsonb array contains), sourceType[]=a&sourceType[]=b (in).

sourceId

query · stringFilter by sourceId. Operators: sourceId=value (equals), sourceId_ne, sourceId_gt, sourceId_gte, sourceId_lt, sourceId_lte, sourceId_like (contains), sourceId_isnull=true|false, sourceId_has=value (jsonb array contains), sourceId[]=a&sourceId[]=b (in).

similarity

query · stringFilter by similarity. Operators: similarity=value (equals), similarity_ne, similarity_gt, similarity_gte, similarity_lt, similarity_lte, similarity_like (contains), similarity_isnull=true|false, similarity_has=value (jsonb array contains), similarity[]=a&similarity[]=b (in).

queryRequired

query · stringSemantic search query

limit

query · number

sourceTypes

query · array

organizationIdRequired

path · stringOrganization ID

projectIdRequired

path · stringProject ID

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const org = await gc.organizations.getOrganizationBySlug({ slug: "my-org" });6const { projects } = await gc.projects.listProjects({ organizationId: org.id });7
8const result = await gc.projects.searchSources({9  organizationId: org.id,10  projectId: projects[0].id,11  query: "example query",12});13

GET

List resolved paths for all published content, for building links and menus

/organizations/{organizationId}/projects/{projectId}/urls

Returns resolved relative URLs for all published content across all apps in the project. Includes pages, posts, articles, etc. with name, path, type, and SEO metadata. Filter by app or type, search by name or path, and sort by any of them. Used for link resolution in AI builders, menus, emails, and navigation.

Parameters

page

query · numberPage number to return, 1-indexed. Defaults to 1.

pageSize

query · numberItems per page (1-100). Defaults to 10.

lite

query · stringWhen 'true', return only essential fields (id, slug, title/name) to reduce payload size. Useful for context fetching and link resolution.

sort

query · stringSort specifier as 'field:direction'. Sortable fields: name, path, type, app. Direction is 'asc' or 'desc' and defaults to 'asc'.

query · stringFree-text search. Matched against: name, path.

app

query · stringFilter by app. Operators: app=value (equals), app_ne, app_gt, app_gte, app_lt, app_lte, app_like (contains), app_isnull=true|false, app_has=value (jsonb array contains), app[]=a&app[]=b (in).

type

query · stringFilter by type. Operators: type=value (equals), type_ne, type_gt, type_gte, type_lt, type_lte, type_like (contains), type_isnull=true|false, type_has=value (jsonb array contains), type[]=a&type[]=b (in).

query · stringFilter by id. Operators: id=value (equals), id_ne, id_gt, id_gte, id_lt, id_lte, id_like (contains), id_isnull=true|false, id_has=value (jsonb array contains), id[]=a&id[]=b (in).

path

query · stringFilter by path. Operators: path=value (equals), path_ne, path_gt, path_gte, path_lt, path_lte, path_like (contains), path_isnull=true|false, path_has=value (jsonb array contains), path[]=a&path[]=b (in).

organizationIdRequired

path · string

projectIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const org = await gc.organizations.getOrganizationBySlug({ slug: "my-org" });6const { projects } = await gc.projects.listProjects({ organizationId: org.id });7
8const { urls } = await gc.projects.listProjectUrls({9  organizationId: org.id,10  projectId: projects[0].id,11});12

GET

Get one project's name, slug, description and settings within an organization

/organizations/{organizationId}/projects/{projectId}

Retrieves the full details of a single project by its unique ID within the specified organization. Returns the project's name, slug, description, settings, and timestamps. The project must belong to the specified organization or a 404 error is returned.

Parameters

organizationIdRequired

path · stringOrganization ID

projectIdRequired

path · stringProject ID

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const org = await gc.organizations.getOrganizationBySlug({ slug: "my-org" });6const { projects } = await gc.projects.listProjects({ organizationId: org.id });7
8const project = await gc.projects.getProject({9  organizationId: org.id,10  projectId: projects[0].id,11});12

GET

List projects in an organization; the IDs every project-level tool needs

/organizations/{organizationId}/projects

Returns a paginated list of all projects belonging to the specified organization. Projects are the top-level containers that hold apps, brandings, and domains. Supports search filtering by project name and pagination via page and pageSize query parameters. Each project in the response includes its unique ID, name, slug, description, and timestamps.

Parameters

page

query · numberPage number to return, 1-indexed. Defaults to 1.

pageSize

query · numberItems per page (1-100). Defaults to 10.

lite

query · stringWhen 'true', return only essential fields (id, slug, title/name) to reduce payload size. Useful for context fetching and link resolution.

sort

query · stringSort specifier as 'field:direction'. Sortable fields: name, slug, description, isActive, createdAt, updatedAt. Direction is 'asc' or 'desc' and defaults to 'asc'.

query · stringFree-text search. Matched against: name, slug.

name

query · stringFilter by name. Operators: name=value (equals), name_ne, name_gt, name_gte, name_lt, name_lte, name_like (contains), name_isnull=true|false, name_has=value (jsonb array contains), name[]=a&name[]=b (in).

slug

query · stringFilter by slug. Operators: slug=value (equals), slug_ne, slug_gt, slug_gte, slug_lt, slug_lte, slug_like (contains), slug_isnull=true|false, slug_has=value (jsonb array contains), slug[]=a&slug[]=b (in).

createdAt

query · stringFilter by createdAt. Operators: createdAt=value (equals), createdAt_ne, createdAt_gt, createdAt_gte, createdAt_lt, createdAt_lte, createdAt_like (contains), createdAt_isnull=true|false, createdAt_has=value (jsonb array contains), createdAt[]=a&createdAt[]=b (in).

updatedAt

query · stringFilter by updatedAt. Operators: updatedAt=value (equals), updatedAt_ne, updatedAt_gt, updatedAt_gte, updatedAt_lt, updatedAt_lte, updatedAt_like (contains), updatedAt_isnull=true|false, updatedAt_has=value (jsonb array contains), updatedAt[]=a&updatedAt[]=b (in).

organizationIdRequired

path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { id: organizationId } = await gc.organizations.getOrganizationBySlug({ slug: "my-org" });6
7const { projects } = await gc.projects.listProjects({ organizationId });8

BuiltAutonomously With AI

This content was built autonomously. Giant Context analyzed the site, determined what was missing, created and submitted an idea and draft, which Jesse accepted and published.