GraphQL
Connection Details
All requests to the GraphQL endpoint should be made with the Content-Type
header set to application/json
, and all responses from the GraphQL endpoint will be returned with the Content-Type
response header set to application/json
. The openai-screenwriter-tutorial-v2 GraphQL API is spec compliant.
To make requests to the Development GraphQL API, use the following URL:
https://openai-screenwriter-tutorial-v2--development.gadget.app/api/graphql
To make requests to the Production GraphQL API, use the following URL:
https://openai-screenwriter-tutorial-v2.gadget.app/api/graphql
Developing using the API Playground
Gadget serves a web-based request console for easy development of custom or complicated queries at openai-screenwriter-tutorial-v2 GraphQL playground. It's handy for exploring the openai-screenwriter-tutorial-v2 API and supports handy features like autocomplete, saved queries, and pretty output formatting.
Connecting with the Gadget API Client
Gadget generates a type-safe, high-quality npm package that can be used in frontend and backend JavaScript projects for the openai-screenwriter-tutorial-v2 API. Find instructions for setting up the API client on the Installing page.
Executing Queries
With a set up GadgetClient
object, you can access data with the .query
function. For more information on the return type of the .query
method, consult the urql
client.query
docs. .query
returns a Promise
for the data from the API in the same shape that the GraphQL query is written. The response
object has the data at the data
property.
1const response = await api.query(`2 query GetAppName {3 gadgetMeta {4 slug5 }6 }7`);89console.log(response.data.gadgetMeta.slug);10// => openai-screenwriter-tutorial-v2
Connecting with fetch
Gadget's GraphQL API can be used without any wrapper client library in JavaScript by using fetch
.
1const result = await fetch(2 "https://openai-screenwriter-tutorial-v2--development.gadget.app/api/graphql",3 {4 headers: {5 accept: "application/json",6 "content-type": "application/json",7 },8 body: JSON.stringify({9 query: `10 query GetAppName {11 gadgetMeta {12 name13 }14 }15 `,16 }),17 method: "POST",18 }19);
Gadget generally recommends using the provided API Client package where possible.
Connecting with cURL
Gadget's GraphQL API can be used from command line HTTP clients like cURL
as well:
curl 'https://openai-screenwriter-tutorial-v2--development.gadget.app/api/graphql' \-H 'accept: application/json' \-H 'content-type: application/json' \--data-raw '{"query":"query { gadgetMeta { slug } }"}'
GraphQL types
Gadget maps Gadget field types to specific GraphQL types for easy consumption of rich data via the GraphQL API.
GraphQL Type: GadgetGraphQLID
Custom GraphQL scalar representing Gadget ID values as strings.
GraphQL Type: GraphQLString
GraphQL Type: GraphQLBoolean
GraphQL Type: GraphQLURL
or GraphQLString
Returns a custom GraphQLURL scalar if URL validation is turned on, and a string otherwise
GraphQL Type: GraphQLEmailAddress
or GraphQLString
Returns a custom GraphQLEmailAddress scalar if URL validation is turned on, and a string otherwise
GraphQL Type: [GraphQLString!]
Returns a list of strings
GraphQL Type: GraphQLRichText
Returns a custom object representing the rich text, with html, markdown and truncatedHTML fields for accessing the content in different ways
GraphQL Type: GraphQLDate
or GraphQLDateTime
Returns a full GraphQLDateTime if the Include Time option is on, and a GraphQLDate otherwise
GraphQL Type: GraphQLInt
or GraphQLFloat
Returns a GraphQLFloat if the allowed number of decimals is unset or greater than 0, and a GraphQLInt otherwise
GraphQL Type: GraphQLJSON
JSON fields are used to store valid JSON. Valid values can be objects, arrays, or scalars including strings and numbers.
GraphQL Type: GraphQLJSON
Deprecated. Any fields act the same as JSON fields.
GraphQL Type: <related object type>
Returns the GraphQL type for the related model.
GraphQL Type: <related object type>
Returns the GraphQL type for the related model.
GraphQL Type: <related object type>Connection
Returns a Relay style Connection interface for accessing the list of related records. The connection has the pageInfo and edges properties.
GraphQL Type: <related object type>Connection
Returns a Relay style Connection interface for accessing the list of related records. The connection has the pageInfo and edges properties.
Required
All of the Gadget GraphQL types are governed by the Required option, which marks them as not null in the GraphQL API's accepted inputs and returned data. Changing the Required-ness of a field in the Gadget Editor will reflect in the GraphQL API immediately.