Not Diamond


    ### Not Diamond API documentation
    

Introduction

Authentication

Chat

Chat Completion API with dynamic model routing.

Create chat completion

Not Diamond API

Production

<p class="slate-p" placeholder="Type / for widgets">Not Diamond dynamically routes queries from your application to either GPT-3.5 Turbo or GPT-4, depending on which model is best-suited for your task.</p><p class="slate-p" placeholder="Type / for widgets">The Not Diamond API is organized around <a href="http://en.wikipedia.org/wiki/Representational_State_Transfer" target="_blank">REST</a>. Our API has predictable resource-oriented URLs, accepts <a href="https://en.wikipedia.org/wiki/POST_(HTTP)#Use_for_submitting_web_forms" target="_blank">form-encoded</a> request bodies, returns <a href="http://www.json.org/" target="_blank">JSON-encoded</a> responses, and uses standard HTTP response codes, authentication, and verbs.</p><p class="slate-p" placeholder="Type / for widgets"></p>

Not Diamond dynamically routes queries from your application to either GPT-3.5 Turbo or GPT-4, depending on which model is best-suited for your task.

. Our API has predictable resource-oriented URLs, accepts 

 responses, and uses standard HTTP response codes, authentication, and verbs.

<p class="slate-p" placeholder="Type / for widgets">The Not Diamond API uses API keys for authentication. <a href="https://notdiamond.ai" target="_blank">Login</a> to your account to retrieve the API key you&apos;ll use in your requests.</p><p class="slate-p" placeholder="Type / for widgets">All API requests should include your API key in an <code class="slate-code">Authorization</code> HTTP header as follows:</p><pre class="slate-CodeBlockElement slate-code_block"><div contenteditable="false"><div ><span aria-live="polite" aria-atomic="false" aria-relevant="additions text" ></span><div ><div ><div >Select...</div><div ><div  style="display:inline-block"><input type="text" autoCapitalize="none" autoComplete="off" autoCorrect="off" id="react-select-5-input" spellcheck="false" tabindex="0" value="" aria-autocomplete="list" style="box-sizing:content-box;width:1px;label:input;background:0;border:0;font-size:inherit;opacity:1;outline:0;padding:0;color:inherit"/><div style="position:absolute;top:0;left:0;visibility:hidden;height:0;overflow:scroll;white-space:pre"></div></div></div></div><div ><span ></span><div  aria-hidden="true"><svg height="20" width="20" viewBox="0 0 20 20" aria-hidden="true" focusable="false" ><path d="M4.516 7.548c0.436-0.446 1.043-0.481 1.576 0l3.908 3.747 3.908-3.747c0.533-0.481 1.141-0.446 1.574 0 0.436 0.445 0.408 1.197 0 1.615-0.406 0.418-4.695 4.502-4.695 4.502-0.217 0.223-0.502 0.335-0.787 0.335s-0.57-0.112-0.789-0.335c0 0-4.287-4.084-4.695-4.502s-0.436-1.17 0-1.615z"></path></svg></div></div></div></div></div><code class="language-shell keep-markup drop-tokens"><div class="slate-code_line">Authorization: Bearer ND_API_KEY</div></code></pre><div  data-type="warning" style="background-color:#FFF8E1;color:#f0b800"><div ><svg width="18" height="16" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M0.916637 15.5009C0.791637 15.5009 0.683998 15.4732 0.59372 15.4176C0.503443 15.362 0.430526 15.2857 0.37497 15.1884C0.319415 15.0912 0.288165 14.9905 0.28122 14.8864C0.274276 14.7822 0.305526 14.6745 0.37497 14.5634L8.4583 0.605103C8.52775 0.493991 8.60761 0.41413 8.69789 0.365519C8.78816 0.316908 8.88886 0.292603 8.99997 0.292603C9.11108 0.292603 9.21178 0.316908 9.30205 0.365519C9.39233 0.41413 9.47219 0.493991 9.54164 0.605103L17.625 14.5634C17.6944 14.6745 17.7257 14.7822 17.7187 14.8864C17.7118 14.9905 17.6805 15.0912 17.625 15.1884C17.5694 15.2857 17.4965 15.362 17.4062 15.4176C17.3159 15.4732 17.2083 15.5009 17.0833 15.5009H0.916637ZM1.99997 14.2509H16L8.99997 2.1676L1.99997 14.2509ZM9.0833 13.0634C9.26386 13.0634 9.41316 13.0044 9.53122 12.8864C9.64928 12.7683 9.7083 12.619 9.7083 12.4384C9.7083 12.2579 9.64928 12.1086 9.53122 11.9905C9.41316 11.8725 9.26386 11.8134 9.0833 11.8134C8.90275 11.8134 8.75344 11.8725 8.63539 11.9905C8.51733 12.1086 8.4583 12.2579 8.4583 12.4384C8.4583 12.619 8.51733 12.7683 8.63539 12.8864C8.75344 13.0044 8.90275 13.0634 9.0833 13.0634ZM9.0833 10.7509C9.26386 10.7509 9.41316 10.6919 9.53122 10.5739C9.64928 10.4558 9.7083 10.3065 9.7083 10.1259V6.70927C9.7083 6.52871 9.64928 6.37941 9.53122 6.26135C9.41316 6.1433 9.26386 6.08427 9.0833 6.08427C8.90275 6.08427 8.75344 6.1433 8.63539 6.26135C8.51733 6.37941 8.4583 6.52871 8.4583 6.70927V10.1259C8.4583 10.3065 8.51733 10.4558 8.63539 10.5739C8.75344 10.6919 8.90275 10.7509 9.0833 10.7509Z" fill="#F1C21B"></path></svg></div><div ><p class="slate-p" placeholder="Type / for widgets"><strong class="slate-bold">Remember that your API key is a secret!</strong>
Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.</p></div></div><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

The Not Diamond API uses API keys for authentication. 

 to your account to retrieve the API key you'll use in your requests.

All API requests should include your API key in an 

<p class="slate-p" placeholder="Type / for widgets">Given a list of messages comprising a conversation, the model will return a response. Message list should be in the following format:</p><p class="slate-p" placeholder="Type / for widgets"></p>

Given a list of messages comprising a conversation, the model will return a response. Message list should be in the following format:

<p class="slate-p" placeholder="Type / for widgets">Chat completion endpoint with dynamic model routing. Your query will either be routed to OpenAI&apos;s GPT-3.5 or GPT-4 based on the content of the query. Our router is trained to optimize for cost and latency while maintaining high response quality. If your query can be adequately answered by GPT-3.5 then we will use it to save you the cost of using GPT-4. If either of these models take too long to respond to your query, we will automatically route to the other one. The default timeout is 5 seconds but can be adjusted in your request.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Chat completion endpoint with dynamic model routing. Your query will either be routed to OpenAI's GPT-3.5 or GPT-4 based on the content of the query. Our router is trained to optimize for cost and latency while maintaining high response quality. If your query can be adequately answered by GPT-3.5 then we will use it to save you the cost of using GPT-4. If either of these models take too long to respond to your query, we will automatically route to the other one. The default timeout is 5 seconds but can be adjusted in your request.

A list of messages comprising the conversation so far.

messages

What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.

temperature

An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.

top_p

How many chat completion choices to generate for each input message.

If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

stream

Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

presence_penalty

Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

frequency_penalty

The Not Diamond model router wait time in seconds. If the selected model does not return a response within timeout, the query is automatically routed to another model.

timeout

A list of functions the model may generate JSON inputs for.

functions

Controls how the model responds to function calls. "none" means the model does not call a function, and responds to the end-user. "auto" means the model can pick between an end-user or calling a function. Specifying a particular function via {"name":\ "my_function"} forces the model to call that function. "none" is the default when no functions are present. "auto" is the default if functions are present.

function_call

Up to 4 sequences where the API will stop generating further tokens.

stop

Modify the likelihood of specified tokens appearing in the completion.  Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

logit_bias

Authorization

A unique identifier for the chat completion.

The object type, which is always chat.completion.

object

A unix timestamp of when the chat completion was created.

created

model

A list of chat completion choices. Can be more than one if n is greater than 1.

choices

Usage statistics for the completion request.

usage

A unique identifier for the chat completion chunk.

The object type, which is always chat.completion.chunk.

A unix timestamp of when the chat completion chunk was created.

detail

Authentication error. This is usually due to an invalid API key.

You may have included some parameters in your request that have to be left blank if you don't need to use it (e.g., "functions")

This error is coming from OpenAI. You may have included some parameters in your request that have to be left blank if you don't need to use it (e.g., "functions").

Sections