Project Apps

Create, configure, restore, and delete project apps.

GET

Get a project app by slug

/organizations/{organizationId}/projects/{projectId}/apps/by-slug/{appSlug}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appSlugRequired: path · string

SDK

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

GET

Read one app's settings, whatever kind of app it is

/organizations/{organizationId}/projects/{projectId}/apps/{appId}/settings

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projectApps.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { settings } = await gc.projectApps.getAppSettings({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

PATCH

Change one app's settings, merging into what is already there

/organizations/{organizationId}/projects/{projectId}/apps/{appId}/settings

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

BodyRequired

settingsRequired: objectOnly the keys being changed. Omitted keys keep their value; send a key as null to clear it. Validated against the app's declared schema.

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projectApps.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const result = await gc.projectApps.updateAppSettings({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16  data: {},17});18

GET

Get a project app by ID

/organizations/{organizationId}/projects/{projectId}/apps/{appId}

Parameters

organizationIdRequired: path · string
projectIdRequired: path · string
appIdRequired: path · string

SDK

1import { createGiantContext } from "@giantcontext/sdk-typescript";2
3const gc = createGiantContext({ apiKey: process.env.GIANTCONTEXT_API_KEY! });4
5const { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projectApps.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11
12const { app } = await gc.projectApps.getProjectApp({13  organizationId: orgs[0].id,14  projectId: projects[0].id,15  appId: apps[0].id,16});17

GET

List soft-deleted apps in a project's trash, restorable or permanently deletable

/organizations/{organizationId}/projects/{projectId}/apps/trash

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
name: query · string
slug: query · string
appType: query · string
isActive: query · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projectApps.listDeletedProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id10});11

GET

List a project's active apps and their types to obtain the appId

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

Parameters

page: query · number
pageSize: query · number
lite: query · string
sort: query · string
search: query · string
name: query · string
slug: query · string
appType: query · string
isActive: query · string
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 { organizations: orgs } = await gc.me.listMyOrganizations();6const { projects } = await gc.projects.listProjects({ organizationId: orgs[0].id });7const { apps } = await gc.projects.listProjectApps({8  organizationId: orgs[0].id,9  projectId: projects[0].id,10});11

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 Giant Context staff accepted and published.