Sign in

Get remix requirements

<Info>This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.</Info>

Returns what you need to know before you remix an app: its name and type, the secrets it uses, the ones the remix copies for you, and whether you can remix it with its chat history. The app must be in the workspace your personal access token is scoped to.

A successful response means you pass the remix permission checks on the app. The remix itself can still be refused, when the app's app_type can't be remixed, when your role or plan doesn't let you create another app in the workspace, or when the app is a user_agent app and Superagent is disabled in the workspace. Read-only tokens are refused here too, even though this endpoint doesn't change anything.

get/api/apps/{app_id}/remix/requirements

Path parameters

app_idstring required

ID of the app to remix.

ID of the app to remix.

Response

What remixing the app involves.

namestring required

Display name of the app. The remix is named after it with (Copy) appended, except for an approved template, where it takes the name of the approved version.

app_typestring required

Type of the app. Only slide, user_agent, user_app, user_game apps can be remixed.

user_descriptionstring nullable required

Description of the app, or null if none was set.

requires_backend_functionsboolean required

Whether the app has deployed backend functions, which the remix copies.

app_secret_namesstring[] required

Names of the secrets set on the app. The remix doesn't copy their values, except the ones in shared_secrets, so pass the rest in secret_values.

shared_secretsstring[] required

Names of the secrets the remix copies automatically, values included. Only an approved workspace template shares secrets, and only with members who can edit in the workspace and aren't the app's owner, collaborators, or workspace admins. Empty otherwise.

is_adminboolean required

Whether you are an editor-level collaborator on the app or an admin of its workspace. You can set with_chat_history when this is true, and also when you own the app.

Example response

{
  "name": "My CRM",
  "app_type": "user_app",
  "user_description": "A CRM to track leads and deals",
  "app_secret_names": [
    "STRIPE_API_KEY",
    "OPENAI_API_KEY"
  ],
  "shared_secrets": [
    "OPENAI_API_KEY"
  ]
}

Changes

Changed in 1 of the 14 revisions of this API.1