GoSearch Logo
API docs by Redocly

GoSearch API Documentation (1.1.0)

Download OpenAPI specification:

Introduction

Welcome to the GoSearch API! You can use this API to access our endpoints, such as the Data Source API, to add a data connector we do not have support for! To access our API, you need to be on the GoSearch Enterprise plan. You can upgrade to the Enterprise plan by reaching out to the sales team.

Authentication

The GoSearch API uses access tokens to authenticate requests. The access token must be included in the Authorization header of your request. To generate an access token, use the "Developer Tools" tab on GoSearch. Please note that only companies on the Enterprise plan are eligible for API tokens.

How to use your Access Token

Once you have an access token, you can use it to make requests to the API. Requests are authenticated using HTTP Bearer Authentication. You must provide the access token in the Authorization header:

Authorization: Bearer {ACCESS_TOKEN}

If you do not provide an access token or your access token is no longer active, you will receive an error message with a 401 status code.

{
  "error": {
    "message": "The API token is not valid or is deactivated.",
    "code": 401,
    "type": "not_authorized"
  }
}

API Overview

The GoSearch API is REST-based and uses standard HTTP verbs and status codes. The API accepts JSON-encoded request bodies and returns JSON-encoded responses. All requests should be made over SSL.

Data Access

API requests don't have access to private data, such as documents from personal connectors.

Base URL

The base URL to access the GoSearch API is https://api.gosearch.ai. For example, to access the Documents endpoint, just add the endpoint to the base URL: https://api.gosearch.ai/documents.

Errors

All responses from the API will include a standard HTTP successful or error status code. The successful status codes are as follows:

HTTP Status Code Description
200 OK The request was successful..
201 Created The resource has been successfully created.

For errors, we include extra information as to why the request was not successful. The error response body will have the following format:

{
  "error": {
    "message": "Descriptive information about the error",
    "code": "HTTP error code",
    "type": "Type of error returned"
  }
}

For example, if you try to create a data source that already exists, you will get the following error response:

{
  "error": {
    "message": "The data source name Slack already exists. Please use another name for the data source.",
    "code": 409,
    "type": "conflict"
  }
}

The error status codes, along with their error types, are as follows:

HTTP Status Code Error Type Description
400 Bad Request bad_request The request cannot be accepted. Might be because the request body is empty when it shouldn’t be.
401 Unauthorized not_authorized The access token provided is invalid or deactivated.
404 Not Found not_found The resource was not found.
405 Method Not Allowed method_not_allowed The request method is not allowed for the endpoint.
409 Conflict conflict The request conflicts with an existing resource. For example, if creating a data source with an existing name, this error will be returned.
415 Unsupported Media Type invalid_content_type The request content type is not supported.
422 Unprocessable Entity invalid_request The contents of the request contains errors, such as required fields that are missing or validation errors.
429 Too Many Requests rate_limit_exceeded The rate limit has been exceeded. You have to wait a short time before trying again.
500 Internal Server Error internal_server_error Something went wrong with the GoSearch API.

Rate Limiting

A rate limit is enforced for every endpoint and is based on the company. It's important to note that creating multiple API tokens will not increase the overall rate limit. Different types of APIs are subject to different rate limits. If you exceed the rate limit, you will receive a 429 status code with the following error body:

{
  "error": {
    "message": "API rate limit exceeded. Please try again in 60 seconds.",
    "code": 429,
    "type": "rate_limit_exceeded"
  }
}

Every request contains information about the rate limit in the HTTP response headers.

HTTP Header Description
RateLimit-Limit The maximum number of requests allowed per minute for the endpoint.
RateLimit-Remaining The number of requests remaining for the current rate limit window.
RateLimit-Reset The number of seconds to wait until the rate limit window resets. This header will only be sent if the rate limit has been exceeded.

Pagination

All the endpoints that return a list come with a metadata object that contains pagination information. We return a default of 10 results per page and use the limit and offset parameters to determine the number of results to return and the number of results to skip. You can fetch the next set of results through the URL that is provided in metadata.links.next. If there are no more results, then the value will be null. The metadata object will include the following parameters. The dot notation denotes a child attribute.

Pagination Parameters Description
limit The limit on the number of results to return, between 1 and 100. Defaults to 10 results.
offset The number of results to skip. Defaults to 0.
count The number of results returned in the current page.
total_results The total number of results found.
links.next The URL link to the next set of results. If there are no more results, this will be null.
links.prev The URL link to the previous set of results. If there are no more results, this will be null.

Support

If you have any questions about the API or are running into errors, please reach out to support@gosearch.ai.

Search

Operations related to searching and search history

Perform search, get history, or popular searches 

https://api.gosearch.ai/search?limit=10&q=How do I reset my password?

This endpoint performs different actions depending on the query parameters provided:

  • Full search: Use q parameter to perform a comprehensive search across all resources.
  • Autocomplete: Use auto parameter to get autocomplete suggestions as the user types.
  • Popular searches: Use popular-searches parameter to retrieve popular searches from history.
  • Search history: Use searchTerm parameter (or no parameters) to retrieve the user's search history.
Authorizations:
API Token
query Parameters
ai_search
boolean

Whether this is an AI search.

auto
string

Search term for autocomplete search. When provided, returns autocomplete suggestions.

category
string
Enum: "files" "tasks" "people" "golinks" "answers" "chats" "customgpts" "images" "events" "all"

Filter results by category.

days
integer

Number of days to look back for analytics.

is_custom_gpt
boolean

Whether the search is for a custom GPT.

limit
integer
Default: 10

Number of results to return.

offset
integer
Default: 0

Number of results to skip.

order
string
Enum: "asc" "desc"

Sort order.

owner
string <email>

Filter by resource owner email.

popular-searches
string

Returns popular searches from search history.

q
string

Search term for full search. When provided, performs a comprehensive search across all resources.

searchTerm
string

Optional search term for history lookup. If provided, returns autocomplete suggestions for recent searches matching this term. If not provided, returns the user's recent search history.

string or Array of strings

Filter by service name(s).

sort
string
Enum: "relevance" "date_created" "date_edited" "weekly_hits"

Field to sort by.

title_only_search
boolean

Whether to search only in titles.

use_federated
boolean

Whether to use federated search.

Responses

Response samples

Content type
application/json
Example
{
  • "metadata": {},
  • "user_query": "How do I reset my password?",
  • "stemmed_query": "reset password",
  • "exact_matches": [ ],
  • "results": [
    ],
  • "people": [ ],
  • "chats": [ ],
  • "golinks": [ ],
  • "tasks": [ ],
  • "answers": [ ],
  • "images": [ ]
}

Integrations

Workspace data source integrations

Get data source configuration 

https://api.gosearch.ai/data-source?name=LinkedIn

Retrieve a data source configuration using the data source name.

Authorizations:
API Token
path Parameters
name
required
string
Example: LinkedIn

Data source name that will be fetched.

Responses

Response samples

Content type
application/json
{}

Get list of data source configurations 

https://api.gosearch.ai/data-source?limit=10&offset=0

Retrieve a list of data source configurations.

Authorizations:
API Token
query Parameters
limit
integer <= 150
Default: 10

The number of results to return per page, between 1-100. Defaults to 10.

offset
integer
Default: 0

The number of results to skip. Defaults to 0.

Responses

Response samples

Content type
application/json
{}

Create data source 

https://api.gosearch.ai/data-source

Create a new data source. You can view data sources in the data connectors page.

Authorizations:
API Token
Request Body schema: application/x-www-form-urlencoded
required
domain
required
string

Verified domain for the data source.

icon_url
required
string <uri>

URL pointing to an image representing the data source. This icon will be shown in the Search UI's light mode for search results.

name
required
string

The unique name of the data source. This name must be unique and will serve as an identifier for the documents indexed under it.

dark_icon_url
string <uri>

URL to an image for the data source's icon in dark mode. If not provided, it defaults to the icon_url.

display_name
string

The name to be displayed in the Search UI. If not provided, it defaults to the name value.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

List connected web sources 

https://api.gosearch.ai/web-source

Returns a paginated list of connected web sources for your workspace. Set the count query parameter to receive only the total count instead of the full list.

Authorizations:
API Token
query Parameters
count
boolean
Default: false

If provided, returns only the total count of connected web sources.

hide_group_connectors
boolean
Default: false

Hide web sources the token owner does not have group access to.

include_group_membership_info
boolean
Default: false

Include group membership summary (num_groups, has_everyone_group) for each web source.

limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of results to return. Defaults to 10. Maximum is 100.

offset
integer >= 0
Default: 0

The number of results to skip. Defaults to 0.

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order. Defaults to desc.

search
string

Filter results by matching the title or description.

sort
string
Default: "connected_at"
Enum: "display_name" "connected_at" "updated_at"

Field to sort by. Defaults to connected_at.

Responses

Response samples

Content type
application/json
Example
{
  • "metadata": {},
  • "results": [
    ]
}

Users

Workspace users and profiles

List workspace users 

https://api.gosearch.ai/users

Returns a paginated list of users in your workspace. You can filter the list by status, access level, role IDs, whether they have the browser extension installed, and more.

If you provide one of username, uid, or email, the endpoint will return a single user.

Authorizations:
API Token
query Parameters
access-level
string
Enum: "admin" "moderator" "member"

Filter by access level. Available only on plans with Custom Admins enabled.

active
boolean

Filter by whether the user is currently active or deactivated.

email
string <email>

If provided, returns a single user by their email address.

install_extension
boolean

Filter by whether the user has installed the browser extension.

limit
integer [ 1 .. 100 ]
Default: 10

The maximum number of results to return. Defaults to 10. Maximum is 100.

metadata_only
boolean
Default: false

When true, returns only the metadata object and omits results.

offset
integer >= 0
Default: 0

The number of results to skip. Defaults to 0.

rids
Array of integers

One or more role IDs to filter by. This parameter accepts multiple values.

search
string

Filter results by matching name or email. Partial matches are supported. Examples: alec, user@, @golinks.io.

status
string

Filter by user status (e.g., active, invited, deactivated).

uid
integer

If provided, returns a single user by their user ID (uid).

username
string

If provided, returns a single user by their username.

with_agents
boolean
Default: false

Return only users who have created custom GPTs (agents).

Responses

Response samples

Content type
application/json
Example
{
  • "metadata": {},
  • "results": [
    ]
}

Answers

Workspace Q&A answers

List workspace answers 

https://api.gosearch.ai/answers

Returns a paginated list of answers in your workspace. You can filter the list by verification status, exclude deprecated answers, and sort by views or creation date.

If you provide aid, the endpoint will return a single answer inside a result wrapper.

Authorizations:
API Token
query Parameters
aid
integer

If provided, returns a single answer by its ID, within a result wrapper.

excludeDeprecated
boolean
Default: false

When true, excludes deprecated answers.

limit
integer [ 1 .. 100 ]
Default: 20

The maximum number of results to return. Defaults to 20. Maximum is 100.

offset
integer >= 0
Default: 0

The number of results to skip. Defaults to 0.

order
string
Default: "desc"
Enum: "desc" "asc"

Sort order. Defaults to desc.

search
string

Filter results by matching the question/title or body. Partial matches are supported.

sort
string
Default: "created_at"
Enum: "views" "created_at"

Sort results by the specified field. Defaults to created_at.

verified
string
Default: "all"
Enum: "all" true false

Filter by verification status. Use true, false, or all to return both. Defaults to all.

Responses

Response samples

Content type
application/json
Example
{
  • "metadata": {},
  • "results": [
    ]
}

Glossary

Workspace glossary terms and definitions

List or fetch glossary terms 

https://api.gosearch.ai/glossary?limit=1000&offset=0

Returns a paginated list of glossary terms ordered alphabetically. You can filter by a search term and/or the first character via startsWith.

If you provide glossaryId or term, the endpoint will return a single glossary entry inside a result wrapper.

Authorizations:
API Token
query Parameters
glossaryId
integer

If provided, returns a single glossary term by its ID, within a result wrapper.

limit
integer [ 1 .. 1000 ]
Default: 1000

The maximum number of results to return. Defaults to 1000. Maximum is 1000.

offset
integer >= 0
Default: 0

The number of results to skip. Defaults to 0.

q
string

Search term to filter glossary terms by term or definition.

string or string

Filter results to terms that start with a specific character or numbers. Provide a single letter (A–Z, case-insensitive) or numbers for numeric terms.

term
string

If provided, returns a single glossary entry by its exact term, within a result wrapper.

Responses

Response samples

Content type
application/json
Example
{
  • "metadata": {
    },
  • "results": [
    ]
}

Groups

Workspace groups and membership

List groups or fetch a single group 

https://api.gosearch.ai/groups

Returns workspace groups. Without gid, the endpoint returns a list of groups in results (no top-level metadata).

If you provide gid, the endpoint returns a single group object. You can use context to paginate a specific nested collection within the group (users or one of the connector types). When a context is provided, the response will include user_metadata (for user) or connector_metadata for connector contexts, describing pagination for that nested collection only.

Authorizations:
API Token
query Parameters
context
string
Enum: "user" "workspace_connector" "web_source" "personal_connector"

When fetching a single group, restrict results to a specific nested collection and include pagination metadata for it.

gid
integer

If provided, returns a single group by its ID.

limit
integer >= 1
Default: 30

Maximum number of items to return. When gid is provided, this limits the number of items inside the selected context (e.g., users or connectors). Defaults to 30 for single-group context pagination.

offset
integer >= 0
Default: 0

Number of items to skip (for nested context pagination or listing).

q
string

Search term to filter groups by name or description.

rid
integer

Optional role ID filter (applies when context is user).

sort_by
string
Enum: "name" "member_count" "connector_count" "updated_at" "created_at" "user_name" "workspace_connector_name" "web_source_name" "personal_connector_name" "rid"

Sort field. For listing groups: name, member_count, connector_count, updated_at, created_at. For a single group (with gid) depending on context: user_name, workspace_connector_name, web_source_name, personal_connector_name, rid.

sort_order
string
Enum: "asc" "desc"

Sort order.

status
string

Optional user status filter (applies when context is user).

Responses

Response samples

Content type
application/json
Example
{
  • "results": [
    ]
}

Uploaded Files

Workspace uploaded files

List uploaded files 

https://api.gosearch.ai/uploaded-files

Returns a paginated list of uploaded files in the workspace.

Note: Personal uploaded files are not available via API tokens. API requests will only return workspace files.

Authorizations:
API Token
query Parameters
limit
integer [ 1 .. 100 ]
Default: 5

Maximum number of items to return. Defaults to 5. Min 1, max 100.

offset
integer >= 0
Default: 0

Number of items to skip.

owner
string <email>

Filter by owner email address.

search
string

Filter by file name (case-insensitive substring match).

sort
string
Default: "newest"
Enum: "newest" "oldest" "name_asc" "name_desc" "size_asc" "size_desc" "owner_asc" "owner_desc"

Sort order for results. Defaults to newest.

Responses

Response samples

Content type
application/json
{}

Admin

Workspace administration and audit logs

Retrieve audit logs 

https://api.gosearch.ai/admin/audit_log?limit=20&offset=0

Retrieve audit logs for the company. Only an API token owned by an admin will be able to use this endpoint.

Authorizations:
API Token
query Parameters
alid
integer

If provided, returns a single audit log by ID.

event_type
string
Enum: "Updated Data Connector" "Sent Form Email" "Deactivated User" "Activated User" "Updated User Access Level" "Resolved AI Feedback" "Unresolved AI Feedback" "Resolved Search Feedback" "Unresolved Search Feedback" "Updated Smart Search" "Updated Popular Searches" "Updated AI Standard Model" "Updated AI Fast Model" "Updated Bedrock Model" "Updated Invite Settings" "Updated OpenAI Key" "Verified Document" "Deprecated Document" "Updated SSO Metadata" "Updated SSO-only Setting" "Updated SSO Enabled Setting" "Updated SSO Login URL" "Updated AI Restricted Mode" "Updated AI Code Generation Settings" "Updated Web Search Settings" "GoAI Query" "Reverted Deprecation" "Reverted Verification" "User added to company" "Company and User initialized" "Updated Enable Request Only" "Updated Workspace Name" "Updated Extension Settings" "Search Query"

Filter logs by event type. Must be one of the enum values.

format
string
Default: "json"
Enum: "json" "ocsf"

The format of the returned data.

limit
integer <= 150
Default: 20

The number of logs to retrieve at a given time. Max 150.

offset
integer
Default: 0

The offset to start retrieving logs from.

search
string

Search term to filter logs by (filters on message, api, or method).

user
string

User email to filter logs by, or 'anyone' for all users.

Responses

Response samples

Content type
application/json
Example
{}

Documents

Index a document 

https://api.gosearch.ai/documents

Adds or updates a document in the index. Indexed documents will show up in search results.

Authorizations:
API Token
Request Body schema: application/json
required
data_source
required
string

Name of the data source that the document will be indexed under.

required
object (Document)

The document to be indexed.

Responses

Request samples

Content type
application/json
{
  • "data_source": "string",
  • "document": {
    }
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

Delete a document 

https://api.gosearch.ai/documents?data_source=LinkedIn&id=3acf5

Remove a document from the index based on the document id.

Authorizations:
API Token
query Parameters
data_source
required
string

The name of the data source under which the document is indexed.

id
required
string

The unique identifier of the document that you want to delete. This identifier corresponds to the document you previously indexed.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Bulk index documents 

https://api.gosearch.ai/documents/bulk

Bulk adds or updates documents in the index.

To efficiently manage the addition or updating of documents in bulk through our API, we've implemented certain guidelines to ensure a smooth experience for all users. We've set a limit of 100 documents per request to maintain system performance and to promote responsible API usage. If you have a larger number of documents to process, we kindly request that you split them into multiple requests, each containing up to 100 documents. Please note that bulk indexing of documents is subject to a different rate limit, allowing for a maximum of 5 API calls per minute.

Authorizations:
API Token
Request Body schema: application/json
required
data_source
required
string

Name of the data source that the document will be indexed under.

required
Array of objects (Document)

List of documents to be indexed. Limited to 100 documents. Excess documents beyond this limit will be truncated without generating errors.

Responses

Request samples

Content type
application/json
{
  • "data_source": "string",
  • "documents": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok"
}

GoAI

List conversations 

https://api.gosearch.ai/goai/conversations

Retrieve a paginated list of conversations with optional filtering and search.

Authorizations:
API Token
query Parameters
cgid
integer >= 0

The cgid of the agent the conversation is associated with. Leaving empty will return all conversations, setting to 0 will return all conversations without an agent.

limit
integer
Default: 10

Number of conversations to return.

offset
integer
Default: 0

Number of conversations to skip.

q
string <= 255 characters

Search term to filter conversations by name and message.

Responses

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "results": [
    ]
}

Get a conversation with chats 

https://api.gosearch.ai/goai/conversations?conversationId=5

Retrieve a specific conversation by ID, including all associated chat messages and owner information.

Authorizations:
API Token
path Parameters
conversationId
required
integer

ID of the conversation to retrieve.

Responses

Response samples

Content type
application/json
{
  • "conversation": {
    },
  • "chats": [
    ],
  • "owner": {
    }
}

Get GoAI response 

https://api.gosearch.ai/goai/response?stream=false&prompt=What%20kind%20of%20things%20can%20I%20ask%20you%3F

Process a user prompt and retrieve an AI-generated response. The response can be streamed in real-time or returned as a complete response after processing.

Note: The size of a GET request is limited by the technical size limits for a GET, based on many factors. For larger prompts, use a POST request.

Authorizations:
API Token
query Parameters
aiOnly
boolean
Default: false

When set to true, enables AI-only mode which limits the response to AI-generated content only, excluding search results and other external data sources. This provides a more focused AI response without additional context from workspace resources or web search.

cgid
integer

The ID of an Agent to use for this conversation. When specified, the conversation will be initialized with the Agent's configuration, instructions, and model settings. The conversationId must not be specified for this to apply - it only works when creating a new conversation.

conversationId
integer

The ID of an existing conversation to continue. If provided, the AI response will be added to this conversation's chat history, maintaining context from previous messages. If not provided, a new conversation will be initialized automatically.

ephemeral
boolean
Default: false

Whether to start a conversation or have this be a single GoAI response.

model
string

The ID of the model to use for the response. If not provided, the default model for the workspace or Agent will be used. Supported models follow the format: provider:model_name. For example, openai:gpt-5.2, openai:gpt-5.2-thinking, anthropic:claude-sonnet-4.5, google:gemini-3-pro, etc.

prompt
required
string

The user's prompt to which the AI should respond. Maximum length of about 2,000 characters. For higher limits, use a POST request.

stream
boolean
Default: false

Whether the response should be streamed back to the client in real-time. When set to true, the response will be sent as a text/event-stream with incremental updates. When false, the complete response is returned after processing is finished.

useWeb
boolean
Default: false

When set to true, enables web search functionality, allowing the AI to search the web for additional information to include in its response. This expands the AI's knowledge beyond the workspace's indexed content and can provide more current or comprehensive information.

Responses

Response samples

Content type
{
  • "completion": {
    },
  • "conversation_id": "54706",
  • "links": "{\"resources\":[]}"
}

Get GoAI response 

https://api.gosearch.ai/goai/response

Process a user prompt and retrieve an AI-generated response using a POST request. The response can be streamed in real-time or returned as a complete response after processing.

Authorizations:
API Token
Request Body schema: application/x-www-form-urlencoded
required
prompt
required
string

The user's prompt to which the AI should respond. Maximum length of 30,000 characters.

aiOnly
boolean
Default: false

When set to true, enables AI-only mode which limits the response to AI-generated content only, excluding search results and other external data sources. This provides a more focused AI response without additional context from workspace resources or web search.

cgid
integer

The ID of an Agent to use for this conversation. When specified, the conversation will be initialized with the Agent's configuration, instructions, and model settings. The conversationId must not be specified for this to apply - it only works when creating a new conversation.

conversationId
integer

The ID of an existing conversation to continue. If provided, the AI response will be added to this conversation's chat history, maintaining context from previous messages. If not provided, a new conversation will be initialized automatically.

ephemeral
boolean
Default: false

Whether to start a conversation or have this be a single GoAI response.

model
string

The ID of the model to use for the response. If not provided, the default model for the workspace or Agent will be used. Supported models follow the format: provider:model_name. For example, openai:gpt-5.2, openai:gpt-5.2-thinking, anthropic:claude-sonnet-4.5, google:gemini-3-pro, etc.

stream
boolean
Default: false

Whether the response should be streamed back to the client in real-time. When set to true, the response will be sent as a text/event-stream with incremental updates. When false, the complete response is returned after processing is finished.

useWeb
boolean
Default: false

When set to true, enables web search functionality, allowing the AI to search the web for additional information to include in its response. This expands the AI's knowledge beyond the workspace's indexed content and can provide more current or comprehensive information.

Responses

Response samples

Content type
{
  • "completion": {
    },
  • "conversation_id": "54706",
  • "links": "{\"resources\":[]}"
}

Summarize a document 

https://api.gosearch.ai/goai/summary?idid=123

Generate a short summary for a document. You can either reference an existing document by idid (workspace indexed document), or provide the document contents directly using title, body, and service.

Notes:

  • External API requests do not have access to personal connector data.
  • When a conversation_id is not provided, a new hidden conversation will be created automatically.
Authorizations:
API Token
query Parameters
body
string

Document content to summarize. Required when providing title and service instead of idid.

conversation_id
integer

Existing conversation ID to continue. If omitted, a new hidden conversation will be created.

file_id
string

Personal Google Drive file ID. Use with personal=true, service=google-drive-personal, and file_type.

file_type
string

Personal Google Drive file type. Use with personal=true, service=google-drive-personal, and file_id.

id
string <uuid>

Personal Notion resource ID (UUID). Use with personal=true, service=notion-personal, and object.

idid
integer

Workspace document ID to summarize. Provide this or title+body+service.

metadata
string
Example: metadata={"path":"/Team/Docs","owner":"user@example.com"}

Optional JSON metadata associated with the non-workspace document.

object
string
Example: object=page

Personal Notion object type (for example, page). Use with personal=true, service=notion-personal, and id.

personal
boolean
Default: false

Flag indicating a personal connector resource. Not available for external API requests.

prompt
string

Optional original search phrase to generate follow-up questions from.

service
string

Integration/service identifier for the document (e.g., google-drive, jira, confluence).

title
string

Document title. Required when providing body and service instead of idid.

Responses

Response samples

Content type
application/json
{
  • "completion": {
    },
  • "follow_up_questions": [ ],
  • "conversationId": 789012
}

Get AI usage information 

https://api.gosearch.ai/goai/ai_usage

Retrieve the remaining GoAI queries for the current day. For paid plans with unlimited queries, returns a flag indicating unlimited access. For freemium users, returns the number of remaining queries available for the day.

Authorizations:
API Token
query Parameters
timezone
string <= 50 characters

Fallback timezone to use if the user's timezone is not set. Used for calculating daily limits.

Responses

Response samples

Content type
application/json
{
  • "remainingGoAIQueries": 2
}

Agents

List Agents 

https://api.gosearch.ai/goai/custom_gpts_search

Retrieve a list of Agents with optional filtering, searching, and sorting. Supports filtering by ownership, popularity, recency, and searching by name.

Authorizations:
API Token
query Parameters
filter
string
Enum: "mine" "team" "new" "popular" "recently_used" "owner"

Filter to apply to the results.

limit
integer
Default: 10

Number of Agents to return.

offset
integer
Default: 0

Number of Agents to skip before starting to retrieve.

order
string
Enum: "asc" "desc"

Sort order.

owner_email
string <email>

Email of the owner to filter by. Required when filter is 'owner'.

search
string

The name of the Agent to search for.

sort
string
Enum: "name" "created_at" "updated_at"

Field to sort by.

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "metadata": {
    }
}