Onboarding

GET/api/company/{companyId}/onboarding/session

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/session \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "session": {
    "onboardingSessionId": 0,
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "stepsCompleted": "stepsCompleted",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "proposals": [
    {
      "onboardingProposalId": 0,
      "onboardingSessionId": 0,
      "companyId": "00000000-0000-0000-0000-000000000000",
      "surface": "surface",
      "sourceType": "sourceType",
      "payloadJson": "payloadJson",
      "modelDeployment": "modelDeployment",
      "promptVersion": "promptVersion",
      "status": "status",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get or create the onboarding session

POST

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/session

Returns the company's in-progress onboarding session with its proposals, creating one if none exists.

Get or create the onboarding session › path Parameters

companyId

string · uuid · required

Get or create the onboarding session › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get or create the onboarding session › Responses

The active session

proposeOnboardingResponse

POST/api/company/{companyId}/onboarding/session

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/session \
  --request POST \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "session": {
    "onboardingSessionId": 0,
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "stepsCompleted": "stepsCompleted",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "proposals": [
    {
      "onboardingProposalId": 0,
      "onboardingSessionId": 0,
      "companyId": "00000000-0000-0000-0000-000000000000",
      "surface": "surface",
      "sourceType": "sourceType",
      "payloadJson": "payloadJson",
      "modelDeployment": "modelDeployment",
      "promptVersion": "promptVersion",
      "status": "status",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Generate AI configuration proposals

POST

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/propose

Proposes configuration rows for a wizard surface from pasted text or imported rows. Requires the onboarding-assistant feature (Starter plan or higher). Rate limited to 20 calls per company per 24 hours.

Generate AI configuration proposals › path Parameters

companyId

string · uuid · required

Generate AI configuration proposals › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Generate AI configuration proposals › Request Body

proposeOnboardingRequest

surface

string

sourceType

string

input

string

onboardingSessionId

integer · int32

Generate AI configuration proposals › Responses

Validated proposal rows. For surface=organisations, the shape is ProposeOrganisationsResponse instead (same envelope, different Rows item type).

onboardingProposalId

integer · int32

materialProposalRow[]

truncated

boolean

promptVersion

string

POST/api/company/{companyId}/onboarding/propose

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/propose \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "surface": "surface",
  "sourceType": "sourceType",
  "input": "input",
  "onboardingSessionId": 0
}'

Example Request Body

{
  "surface": "surface",
  "sourceType": "sourceType",
  "input": "input",
  "onboardingSessionId": 0
}

json

Example Responses

{
  "onboardingProposalId": 0,
  "rows": [
    {
      "referenceMaterialId": 0,
      "category": "category",
      "value": "value",
      "isCustom": true,
      "confidence": 0,
      "sourceExcerpt": "sourceExcerpt",
      "issue": "issue"
    }
  ],
  "truncated": true,
  "promptVersion": "promptVersion"
}

json

application/json

Update a proposal's status

PATCH

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/proposal/{proposalId}

Records the admin's decision on an AI proposal: Accepted, Rejected, or Applied.

Update a proposal's status › path Parameters

companyId

string · uuid · required

proposalId

integer · int32 · required

Update a proposal's status › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update a proposal's status › Request Body

updateOnboardingProposalRequest

status

string

Update a proposal's status › Responses

Status updated

No data returned

Update the onboarding session

PATCH

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/session/{sessionId}

Sets the session status (Completed/Dismissed) and/or records a completed step.

Update the onboarding session › path Parameters

companyId

string · uuid · required

sessionId

integer · int32 · required

Update the onboarding session › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update the onboarding session › Request Body

updateOnboardingSessionRequest

status

string

completedStep

string

Update the onboarding session › Responses

Updated session

OrderLineItems MillCertTags

onboardingSessionId

integer · int32

companyId

string · uuid

status

string

stepsCompleted

string

createdBy

string · uuid

createdAt

string · date-time

updatedAt

string · date-time

PATCH/api/company/{companyId}/onboarding/session/{sessionId}

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/session/:sessionId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "status": "status",
  "completedStep": "completedStep"
}'

Example Request Body

{
  "status": "status",
  "completedStep": "completedStep"
}

json

Example Responses

{
  "onboardingSessionId": 0,
  "companyId": "00000000-0000-0000-0000-000000000000",
  "status": "status",
  "stepsCompleted": "stepsCompleted",
  "createdBy": "00000000-0000-0000-0000-000000000000",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

GoSmarter API Gateway

Onboarding

Get the latest onboarding session

GET

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/session

Returns the company's most recent onboarding session with its proposals. 404 when the company has never started onboarding.

Get the latest onboarding session › path Parameters

companyId

string · uuid · required

Get the latest onboarding session › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get the latest onboarding session › Responses

The latest session

GET/api/company/{companyId}/onboarding/session

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/session \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "session": {
    "onboardingSessionId": 0,
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "stepsCompleted": "stepsCompleted",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "proposals": [
    {
      "onboardingProposalId": 0,
      "onboardingSessionId": 0,
      "companyId": "00000000-0000-0000-0000-000000000000",
      "surface": "surface",
      "sourceType": "sourceType",
      "payloadJson": "payloadJson",
      "modelDeployment": "modelDeployment",
      "promptVersion": "promptVersion",
      "status": "status",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Get or create the onboarding session

POST

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/session

Returns the company's in-progress onboarding session with its proposals, creating one if none exists.

Get or create the onboarding session › path Parameters

companyId

string · uuid · required

Get or create the onboarding session › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get or create the onboarding session › Responses

The active session

proposeOnboardingResponse

POST/api/company/{companyId}/onboarding/session

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/session \
  --request POST \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "session": {
    "onboardingSessionId": 0,
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": "status",
    "stepsCompleted": "stepsCompleted",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  },
  "proposals": [
    {
      "onboardingProposalId": 0,
      "onboardingSessionId": 0,
      "companyId": "00000000-0000-0000-0000-000000000000",
      "surface": "surface",
      "sourceType": "sourceType",
      "payloadJson": "payloadJson",
      "modelDeployment": "modelDeployment",
      "promptVersion": "promptVersion",
      "status": "status",
      "createdBy": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2024-08-25T15:00:00Z",
      "updatedAt": "2024-08-25T15:00:00Z"
    }
  ]
}

json

application/json

Generate AI configuration proposals

POST

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/propose

Generate AI configuration proposals › path Parameters

companyId

string · uuid · required

Generate AI configuration proposals › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Generate AI configuration proposals › Request Body

proposeOnboardingRequest

surface

string

sourceType

string

input

string

onboardingSessionId

integer · int32

Generate AI configuration proposals › Responses

Validated proposal rows. For surface=organisations, the shape is ProposeOrganisationsResponse instead (same envelope, different Rows item type).

onboardingProposalId

integer · int32

materialProposalRow[]

truncated

boolean

promptVersion

string

POST/api/company/{companyId}/onboarding/propose

curl https://api.gosmarter.ai/api/company/:companyId/onboarding/propose \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "surface": "surface",
  "sourceType": "sourceType",
  "input": "input",
  "onboardingSessionId": 0
}'

Example Request Body

{
  "surface": "surface",
  "sourceType": "sourceType",
  "input": "input",
  "onboardingSessionId": 0
}

json

Example Responses

{
  "onboardingProposalId": 0,
  "rows": [
    {
      "referenceMaterialId": 0,
      "category": "category",
      "value": "value",
      "isCustom": true,
      "confidence": 0,
      "sourceExcerpt": "sourceExcerpt",
      "issue": "issue"
    }
  ],
  "truncated": true,
  "promptVersion": "promptVersion"
}

json

application/json

Update a proposal's status

PATCH

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/proposal/{proposalId}

Records the admin's decision on an AI proposal: Accepted, Rejected, or Applied.

Update a proposal's status › path Parameters

companyId

string · uuid · required

proposalId

integer · int32 · required

Update a proposal's status › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update a proposal's status › Request Body

updateOnboardingProposalRequest

status

string

Update a proposal's status › Responses

Status updated

No data returned

Update the onboarding session

PATCH

https://api.gosmarter.ai

/api/company/{companyId}/onboarding/session/{sessionId}

Sets the session status (Completed/Dismissed) and/or records a completed step.

Update the onboarding session › path Parameters

companyId

string · uuid · required

sessionId

integer · int32 · required

Update the onboarding session › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Update the onboarding session › Request Body

updateOnboardingSessionRequest

status

string

completedStep

string

Update the onboarding session › Responses

Updated session